srve4 / ezdocs Goto Github PK

ezdocs is a documentation generator that converts Markdown to HTML using the Blackfriday tool by Russ Ross and rendered using Bootstrap 2 (United theme by default). All you need is a Go web server and some JavaScript.

The left sidebar serves as table of contents for a particular topic.

The right sidebar serves as the actual content where code is syntax highlighted according to GitHub style.

See examples:

• itmarketplace.net/gobyexample
• itmarketplace.net/sql
• itmarketplace.net/gocheatsheet

• Markdown to HTML (using Blackfriday tool)
• Bootstrap 2 (United theme by default)
• Static content but dynamically rendered at client-side using AJAX
• Tree view of table of contents (left side bar)
• Powered by highlight.js for syntax highlight

• The table of contents can be 3 levels deep
• Bootstrap 2 theme can be modified (located at css folder)

• css
• html
• img
• js
• index.html

Download Blackfriday Tool at https://github.com/itmarketplace/blackfriday-tool/releases

bt article.md article.html

Download here

  var routes = {
	//javascript
	'/anchor': newHandler(f, "anchor"),
	'/kiss': newHandler(f, "kiss"),
	'/httprouter': newHandler(f, "httprouter"),
	'/jwt':  newHandler(f, "jwt"),
	'/salt': newHandler(f, "salt")
  }

For example, if you extracted Caddy to C:\web and your static files are at C:\web\static

you can see your ezdocs at http://localhost:2015/static

MIT

Copyright (c) 2016 - Isagani Mendoza