All Projects β†’ sinedied β†’ Hads

sinedied / Hads

Licence: mit
πŸ“š Markdown superpowered documentation for Node.js

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to Hads

Commonmark
Highly-extensible PHP Markdown parser which fully supports the CommonMark and GFM specs.
Stars: ✭ 2,128 (+1347.62%)
Mutual labels:  hacktoberfest, markdown, gfm
Markserv
🏁 serve markdown as html (GitHub style), index directories, live-reload as you edit
Stars: ✭ 304 (+106.8%)
Mutual labels:  markdown, server, gfm
Dvc.org
πŸ”— DVC website and documentation
Stars: ✭ 171 (+16.33%)
Mutual labels:  hacktoberfest, documentation, markdown
Wiki
Wiki.js | A modern and powerful wiki app built on Node.js
Stars: ✭ 14,985 (+10093.88%)
Mutual labels:  documentation, wiki, markdown
Docs
Documentation for Tasmota (https://github.com/arendst/Tasmota)
Stars: ✭ 55 (-62.59%)
Mutual labels:  hacktoberfest, documentation, wiki
Documentation
The source for Datadog's documentation site.
Stars: ✭ 147 (+0%)
Mutual labels:  hacktoberfest, documentation, wiki
Editor.md
The open source embeddable online markdown editor (component).
Stars: ✭ 11,741 (+7887.07%)
Mutual labels:  documentation, markdown, gfm
Tui.editor
πŸžπŸ“ Markdown WYSIWYG Editor. GFM Standard + Chart & UML Extensible.
Stars: ✭ 14,016 (+9434.69%)
Mutual labels:  documentation, markdown, gfm
Settingsguide
More extensive explanations of Cura slicing settings.
Stars: ✭ 55 (-62.59%)
Mutual labels:  hacktoberfest, documentation, markdown
Markdown
A super fast, highly extensible markdown parser for PHP
Stars: ✭ 945 (+542.86%)
Mutual labels:  hacktoberfest, markdown, gfm
Docs
Repository of Twilio SendGrid's product documentation.
Stars: ✭ 221 (+50.34%)
Mutual labels:  hacktoberfest, documentation, markdown
Wiki
Awesome way to learn together! 🀣
Stars: ✭ 119 (-19.05%)
Mutual labels:  documentation, wiki, markdown
Backslide
πŸ’¦ CLI tool for making HTML presentations with Remark.js using Markdown
Stars: ✭ 679 (+361.9%)
Mutual labels:  hacktoberfest, markdown, server
Community
Modern Confluence alternative designed for internal & external docs, built with Golang + EmberJS
Stars: ✭ 1,286 (+774.83%)
Mutual labels:  documentation, wiki, knowledgebase
Githubdocs
Easily build a searchable documentation app using markdown files in your Github Repo or local Markdown files.
Stars: ✭ 122 (-17.01%)
Mutual labels:  wiki, knowledgebase, markdown
Torchbear
πŸ”₯🐻 The Speakeasy Scripting Engine Which Combines Speed, Safety, and Simplicity
Stars: ✭ 128 (-12.93%)
Mutual labels:  hacktoberfest, markdown
Ocpp
Python implementation of the Open Charge Point Protocol (OCPP).
Stars: ✭ 127 (-13.61%)
Mutual labels:  hacktoberfest, server
Handbook
πŸ“– Complete documentation for WP-CLI
Stars: ✭ 129 (-12.24%)
Mutual labels:  hacktoberfest, documentation
Health
Laravel Health Panel
Stars: ✭ 1,774 (+1106.8%)
Mutual labels:  hacktoberfest, server
Hydra
OpenID Certifiedβ„’ OpenID Connect and OAuth Provider written in Go - cloud native, security-first, open source API security for your infrastructure. SDKs for any language. Compatible with MITREid.
Stars: ✭ 11,884 (+7984.35%)
Mutual labels:  hacktoberfest, server

Hey it's Another Documentation Server! (hads)

NPM version Build Status Node version XO code style Downloads License

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)
  -e, --export      Export static HTML             [default: "./public"]
  --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.

Table of contents

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

Navigation index

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.

The sorting of each index level is as follows:

  1. Any README.md, readme.md, or index.md is always at the top.
  2. All files and folders that are prefixed with a number (e.g. 001-abc and 002 mno and 003_xyz) are next, sorted by their respective prefix numbers. Note that the prefix numbers are stripped out in the index.
  3. All remaining files, sorted by their name.
  4. All remaining folders, sorted by their name.

Mermaid 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

Variants

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].