mdserver

command module
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 11, 2019 License: MIT Imports: 20 Imported by: 0

README

Command mdserver is an http server serving single directory with markdown
(.md) files. If can render automatically built index of those files and
render them as html pages.

Its main use-case is reading through directory with documentation written in
markdown format, i.e. local copy of Github wiki.

To access automatically generated index, request "/?index" path, as
http://localhost:8080/?index.

Note that table of contents generating javascript is a modified version of
code found at https://github.com/matthewkastor/html-table-of-contents which
is licensed under GNU GENERAL PUBLIC LICENSE Version 3.

Documentation

Overview

Command mdserver is an http server serving single directory with markdown (.md) files. If can render automatically built index of those files and render them as html pages.

Its main use-case is reading through directory with documentation written in markdown format, i.e. local copy of Github wiki.

To access automatically generated index, request "/?index" path, as http://localhost:8080/?index.

Note that table of contents generating javascript is a modified version of code found at https://github.com/matthewkastor/html-table-of-contents which is licensed under GNU GENERAL PUBLIC LICENSE Version 3.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL