Package Exports

hads

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hads) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Hey it's Another Documentation Server! (hads)

Node version Downloads

The master of hell docs

Hads is a fast Node.js based web server allowing to browse, search and edit documentation written in Markdown.

screenshot

Features:

No configuration needed
Github-like presentation
GFM (Github Flavoured Markdown)
Automatic indexation and search
In-browser editor
Table of contents using Markdown extension [[toc]]
Navigation index using Markdown extension [[index]]
Diagrams and flowcharts using Mermaid syntax
Drag'n drop images
100% offline
Custom CSS style

Usage

npm install -g hads
hads -o

Your browser will open http://localhost:4040 and display your project documentation.

Command-line options

Usage: hads [root dir] [options]

Options:
  -p, --port        Port number to listen on       [default: 4040]
  -h, --host        Host address to bind to        [default: "localhost"]
  -i, --images-dir  Directory to store images      [default: "images"]
  -o, --open        Open default browser on start
  -r, --readonly    Read-only mode (no add or edit feature)
  --help            Show this help

If no root dir is specified, ./ will be used.

Extras

Home page

The server will automatically search for a file named index.md, readme.md or README.md on the specified documentation root and will use it as your home page.

You can customize the CSS style in a file named custom.css.

The special text [[toc]] will be replaced by the table of contents of the markdown document, based on headings.

The special text [[index]] will be replaced by the full navigation index of all markdown files found under the specified root dir. File and folder names will be humanized for better readability.

It is particularly useful on the home page to provide an overview of the available documentation for your project.

Diagrams and flowcharts

You can use the Mermaid syntax to insert diagrams and flowcharts directly in your markdown, but using code blocks with the mermaid language specified, like this:

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

Mermaid configuration can be overridden on a given page using the global variable MERMAID_CONFIG in a <script> tag, for example:

<script>
MERMAID_CONFIG = { theme: 'forest' };
</script>

Updates

See changelog here

hads