read-only wiki rendering engine

[damonpetta]

Overview

A simple markdown rendering engine to be the backbone a distributed documentation infrastructure project. This will run as a series of dockerized applications to take content from both public and private git repos and github wikis and surface the information openly behind the firewall of an enterprise.

• [x] render markdown files to html template Github Markdown or blackfriday look to be the best suited markdown processors
  • [x] (?i) home.md, index.md and README.md as default documents otherwise default to list of files
  • [x] stripping .md from urls /Home.md -> /Home
  • [x] monitor file system for updates push updates over websockets to active browsers golang.org/x/net/websocket and github.com/rjeczalik/notify
  • [x] simple clean html / css / javascript template Note: need to be easy to edit (tmpl files) and compiled into the application see Packr
• [x] if custom css and js /custom.css /custom.js exist in the repo they should be included at render time
• [x] <title> tag of the page should be the first H1 in the markdown
• [x] Includes for sections of the page _header.md _Footer.md _Sidebar.md all (?i)

Idea References:

• LiveMD
• Gollum have been most of the inspiration

[damonpetta]

Example of what it would look like based off git clone https://github.com/damonpetta/rowi.wiki.git