Negating Past Mistakes

    @aventum/docsator

    1.0.1 • Public • Published

    Docsator

    Docs generator(docsgenerator) for Aventum! Docsator accepts any JSDoc style comments and group the comments by tag and formats them to Markdown files.

    Currently it is can collect only Aventum Hooks

    Table of Contents

    1. Documentation

      1. Requirements
      2. Installation
      3. How to use it
      4. How it works
      5. docsator.config.json
    2. Support

    3. License

    Documentation

    Requirements

    1. Make sure you have the latest version of Node.js installed.
    2. Proper docsator.config.json file.

    Installation

    Run:

    npm install @aventum/docsator -g

    How to use it?

    Go to the folder that contains the js(files/folders) and you have permissions to write into it and run:

    docsator

    Docsator will recursively collect the js files from the folders.

    How it works

    Docsator uses comment-parser behind the scenes to parse the comments.

    docsator.config.json

    Docsator reads its configurations from this file, here is a sample of what this file must contain:

    {
      "replace": "__dirname",
      "with": "",
      "folder": "docs",
      "tags": [
        {
          "tag": "hook",
          "file": "hooks.md"
        }
      ]
    }

    You can create this file manually using any text editor, here is what every configuration means:

    • replace and with: (String) Replace replace with the with option in the file name that will be printed in the documentation(the file that contains the comment, i.e. the source file), use either __dirname to refer the current folder or a hardcoded path.
    • folder: (String) The folder that Docsator will put the documentation files in.
    • tags: (Array) Array of tags, for the example above Docsator will generate hooks.md file that contains the formatted comments, these comments contain the hook tag.

    Support

    You are welcome to contribute code and provide pull requests for Docsator, also please feel free to suggest or request any features or enhancements.

    License

    Copyright (c) 2019 Mohammed Al-Mahdawi Licensed under the MIT license.

    Install

    npm i @aventum/docsator

    DownloadsWeekly Downloads

    1

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    7.67 kB

    Total Files

    6

    Last publish

    Collaborators

    • mohammed_al-mahdawi