Giter Club home page Giter Club logo

markedwithtoc's Introduction

渲染Markdown，自动增加目录 Join the chat at https://gitter.im/zhengxiaoyao0716/chatroom

Render markdown file, auto add a float-fold TOC.

一个工具性质的网页，可以渲染Markdown文件

并为H1、H2号标题自动增加一个浮动且自动折叠的TOC

Try it now

试试看

我提供了一份接口文档示范，[test_api.md]，你可以尝试把它拖进去看看

2016/3/18: 注意，第一个一级标题会被无视，因为要作为文档标题嘛
2016/3/17: 现在你可以将渲染好的html一键保存到本地了！

Dark theme: 黑色主题预览效果

Dark theme

Light theme: 白色主题预览效果

Light theme

虽然可以用它渲染任何遵循Markdown语法的文件
但它更适合、或者说主要是为了渲染Http接口文档

因为我做了以下优化：

1、在jasonm23提供的css样式基础上，修改定制黑、白两套CSS样式，主要修改表格样式，明暗间隔以便区分，并适当调整字号，使更适合作为接口文档来阅读

2、比起别的Markdown增加TOC的项目，我只为H1、H2号标题做导航，对于接口文档来说这足矣，太多的目录反而不适合

3、导航目录是浮动在左侧的，不会随着文档滚动，失去焦点后自动折叠，这样更方便作为一份接口文档来查看

那么现在来试试拖拽.md文件来预览吧？这应该比上传到GitHub后查看方便许多

Try it now

试试看

如果你把该功能想整合进自己的网页里，那么需要引用marked_with_toc.js、dark或light主题

它依赖于/chjj/marked渲染Markdown文本，你需要一起引用

markedwithtoc's People

Contributors

zhengxiaoyao0716 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.