ad-docs

A cli to transform markdown to html

install

npm i ad-docs --save-dev

or

yarn add ad-docs -D

usage

npx ad-docs -h

Usage: cli [options]

Options:
  -o --out <path>  path where save the html (default: "/dist")
  --cwd <path>     current working directory
  run              run on browser
  -V, --version    output the version number
  -h, --help       display help for command

• cwd current working directory, default is where you run npx ad-docs command
• out path of the output html file, it will use cwd as base path

Example

npx ad-docs

Above command will transform all .md files to .html from current directory to dist

npx ad-docs run

Above command will run all .html files and open browser

deps

• commander

• gulp

• gulp docs

• vinyl files

• gulp-plumber

  predictable stream error management

• browser sync

• gulp sass

• dart-sass

• gulp-markdown

• marked

• marked options

• markdown-it, alternative to marked

• glob

• multipipe

  this one allows for grouping of pipe streams for DRY

publish

• npm docs

This module is made available on npm as ad-docs.

maintainer: aquilinedrones

• with username/password

  npm login
  npm publish

• with automation token

  export NPM_TOKEN="<your token here>"
  yarn publish

• why is the .npmrc file not on the root of the project?

Since the file requires an env var, NPM_TOKEN, if that is not declared on the shell session, any npm or yarn command will actually fail, which is not a good dev UX.

License

MIT