npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hads

v3.0.3

Published

Fast web server allowing to browse, search and edit project documentation written in Markdown

Downloads

23,722

Readme

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