view and edit your local markdown documentations in browser. full text search as well
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
doc
lib
public
test
views
.editorconfig
.eslintrc
.gitattributes
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
gulpfile.js
index.js
package.json

README.md

doc-viewer

Build Status

logo

View markdown documentations locally in browser

Usage

  • npm install -g doc-viewer
  • run doc-viewer in the folder where you have your doc, it will start a server.
  • localhost:3000/fileName.md to view rendered markdown
  • it also works like the simple http server in python.

You can update current version using npm update -g doc-viewer

Features

  • TOC (table of content) support
  • Show folder and files in sidebar
  • gfm (support task list ) -> use marked
  • code highlight -> use highlightjs

Screen shot

screen

Develop

  • npm install NOTE: you have to run as admin in windows in order to install node-sass
  • gulp dev to start server and enable watch, the express server will reload when file change, but you have to hit f5 to refresh the client.

RoadMap

  • simple render
  • a global command line. npm install -g doc-viewer, then you can use it like python's simple server
  • make links in markdown work.
  • toc support
  • support task list #17
  • allow combine options, toc, highlight etc.
  • parse all markdown file and generate html and search.