simple

Introduction

Documentation generator for your plugin, library or framework.

Quick Start

The get started quickly create one or more Markdown .md files and inside that folder run the following from the console having node installed:

npx docy

You'll be asked whether you want open the result in the browser and watch for changes.

Regular Installation

To get started set up a package.json in the folder where you want to keep the documentation.

{
  "name": "my-documentation",
  "scripts": {
    "start": "docy",
    "develop": "docy --watch --open",
    "build": "docy --build"
  }
}

If you already have a package.json add the script that matches your needs best.

First install docy by running npm install docy and then generate the documentation running npm start.

Structure

The documentation is stored inside markdown files.

Simple

docy
├── 1-intro.md
├── 2-installation.md
├── 3-usage.md
└── 4-license.md

Files inside a folder will be ordered alphabetically, to avoid this and keep the desired order add numbers in front. The filename will only be used for the purpose of ordering the contents.

Groups

docy
├── 1-introduction
│   ├── 1-welcome.md
│   └── 2-intro.md
├── 2-installation
|   ├── 1-regular.md
│   └── 2-global.md
├── 3-usage.md
└── 4-license.md

For more complex documentations the files can be nested inside folders to represent different levels.

Contents

Here's how an example Markdown .md file could look like:

# Installation

to install run `npm i docy`.

License

MIT