DEV Community


Posted on • Updated on

build up a documentation site from markdown files

Finally done for this stage. Now I can keep one copy of document in markdown format for github, web documents and local documentation.

Just a simple index.html page, to build up a documentation site from markdown files.

Simply copy the following file to web server, then everything is DONE!.


layout of Documentation Site


index.html is a simple document framework for showing markdown files with auto-TOC navigation. It is a single html page in pure javascript without dependence.

The program also include a simple markdown parser (55 lines js code) and a simple TOC (table-of-content) in pure javascript.

a little rush, kindly advise,

have a nice day,

Discussion (0)