{"id":13398037,"url":"https://github.com/sinedied/hads","last_synced_at":"2025-04-05T05:05:40.048Z","repository":{"id":11344684,"uuid":"69031333","full_name":"sinedied/hads","owner":"sinedied","description":":books: Markdown superpowered documentation for Node.js","archived":false,"fork":false,"pushed_at":"2022-05-02T12:46:58.000Z","size":1172,"stargazers_count":170,"open_issues_count":12,"forks_count":28,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-29T01:11:57.175Z","etag":null,"topics":["documentation","gfm","hacktoberfest","knowledgebase","markdown","mermaid","nodejs","offline","server","wiki"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sinedied.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-23T14:15:52.000Z","updated_at":"2025-03-27T12:41:37.000Z","dependencies_parsed_at":"2022-08-08T05:15:11.586Z","dependency_job_id":null,"html_url":"https://github.com/sinedied/hads","commit_stats":null,"previous_names":["sinedied/mdds"],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinedied%2Fhads","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinedied%2Fhads/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinedied%2Fhads/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinedied%2Fhads/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sinedied","download_url":"https://codeload.github.com/sinedied/hads/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289426,"owners_count":20914464,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","gfm","hacktoberfest","knowledgebase","markdown","mermaid","nodejs","offline","server","wiki"],"created_at":"2024-07-30T18:02:03.214Z","updated_at":"2025-04-05T05:05:40.031Z","avatar_url":"https://github.com/sinedied.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Getting Started","documentation"],"sub_categories":["Prerequisites"],"readme":"# Hey it's Another Documentation Server! (hads)\n\n[![NPM version](https://img.shields.io/npm/v/hads.svg)](https://www.npmjs.com/package/hads)\n[![Build Status](https://github.com/sinedied/hads/workflows/build/badge.svg)](https://github.com/sinedied/hads/actions)\n![Node version](https://img.shields.io/node/v/hads.svg)\n[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)\n![Downloads](https://img.shields.io/npm/dm/hads.svg)\n[![License](https://img.shields.io/npm/l/hads.svg)](LICENSE)\n\n### *The master of ~~hell~~ docs*\n\n\u003e **Hads** is a fast Node.js based web server allowing to browse, search and edit documentation written in\n[Markdown](http://daringfireball.net/projects/markdown/).\n\n![screenshot](https://cloud.githubusercontent.com/assets/593151/24351859/afb0b958-12e7-11e7-8ad4-8655e6b3c1c1.png)\n\n**Features**:\n\n- No configuration needed\n- Github-like presentation\n- GFM ([Github Flavoured Markdown](https://guides.github.com/features/mastering-markdown/))\n- Automatic indexation and search\n- In-browser editor\n- Table of contents using Markdown extension `[[toc]]`\n- Navigation index using Markdown extension `[[index]]`\n- Diagrams and flowcharts using [Mermaid](http://knsv.github.io/mermaid/) syntax\n- Drag'n drop images\n- 100% offline\n- Custom CSS style\n\n\n## Usage\n\n```bash\nnpm install -g hads\nhads -o\n```\n\nYour browser will open `http://localhost:4040` and display your project documentation.\n\n### Command-line options\n\n```\nUsage: hads [root dir] [options]\n\nOptions:\n  -p, --port        Port number to listen on       [default: 4040]\n  -h, --host        Host address to bind to        [default: \"localhost\"]\n  -i, --images-dir  Directory to store images      [default: \"images\"]\n  -o, --open        Open default browser on start\n  -r, --readonly    Read-only mode (no add or edit feature)\n  -e, --export      Export static HTML             [default: \"./public\"]\n  --help            Show this help\n```\n\nIf no root dir is specified, `./` will be used.\n\n## Extras\n\n### Home page\n\nThe server will automatically search for a file named `index.md`, `readme.md` or `README.md` on the specified\ndocumentation root and will use it as your home page.\n\nYou can customize the CSS style in a file named `custom.css`.\n\n### Table of contents\n\nThe special text `[[toc]]` will be replaced by the table of contents of the markdown document, based on headings.\n\n### Navigation index\n\nThe special text `[[index]]` will be replaced by the full navigation index of all markdown files found under the\nspecified *root dir*. File and folder names will be *humanized* for better readability.\n\nIt is particularly useful on the home page to provide an overview of the available documentation for your project.\n\nThe sorting of each index level is as follows:\n1. Any README.md, readme.md, or index.md is always at the top.\n2. All files and folders that are prefixed with a number (e.g. `001-abc` and `002 mno` and `003_xyz`) are next, sorted \nby their respective prefix numbers. Note that the prefix numbers are stripped out in the index.\n3. All remaining files, sorted by their name.\n4. All remaining folders, sorted by their name.  \n\n### Mermaid Diagrams and flowcharts\n\nYou can use the [Mermaid](http://knsv.github.io/mermaid/) syntax to insert diagrams and flowcharts directly in your\nmarkdown, but using code blocks with the `mermaid` language specified, like this:\n\n    ```mermaid\n    graph TD;\n        A--\u003eB;\n        A--\u003eC;\n        B--\u003eD;\n        C--\u003eD;\n    ```\n\nMermaid [configuration](https://mermaidjs.github.io/mermaidAPI.html) can be overridden on a given page using the global variable `MERMAID_CONFIG` in a `\u003cscript\u003e` tag, for example:\n\n```html\n\u003cscript\u003e\nMERMAID_CONFIG = { theme: 'forest' };\n\u003c/script\u003e\n```\n\n## Updates\n\nSee changelog [here](CHANGELOG.md)\n\n## Variants\n- [hads-plantuml](https://www.npmjs.com/package/hads-plantuml): Adds PlantUML support for diagrams\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinedied%2Fhads","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsinedied%2Fhads","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinedied%2Fhads/lists"}