DOCNATOR

||| :no_entry_sign: in progress, docnator still are in development. |||

docnator is a CLI for generate the documentation of your javascript project, take your jsdocs, transform in markdown files, and use gitbook template.

Instalation

Global

global instalation for use in any project with jsdocs.

# yarn
$ yarn global add docnator

# npm
$ npm install docnator --global

Usage

$ docnator src

Local

local instalation for the especific project

# yarn
$ yarn add docnator

# npm
$ npm install docnator

Usage

$ node_modules/docnator/bin/docnator.js src
# you can create a script in your package.json
# ex: "docnator:build": "node_modules/docnator/bin/docnator.js src"

Commands

build

comand for generate the documentation.

$ docnator <target> [summaryPath] [extension]
# ex: docnator lib js

|arg|description|required|default value| |---|-----------|--------|-------------| |target| source files directory | true | null | |summaryPath| path of SUMMARY.md | false | ./SUMMARY.md | |extension| define the exclusive extension file | false | js, jsx |

server

create a local server with gitbook for your documentations, use git book CLI

Motivation

Docnator has be created to use jsdocs in javascript documentation with gitbook for developers reference. This frameworks are most easy to use and bring great help for developer community.