bukinoshita / now-docs

[WIP] Deploy docs with a single command using Now

Deploy docs with a single command using now.

Install

$ npm install -g now-docs

Usage

$ now-docs --help

  Usage:
    $ docs                      Deploy `now-docs`

  Options:
    -h, --help                  Show help options
    -v, --version               Show version

Related

• zeit/now — Universal serverless single-command deployment
• now-domains — Check now domains availability and pricing
• now-domains-status — Check now domains availability
• now-domains-price — Check now domains price
• netlify-docs — Deploy docs with a single command using Netlify

Comparing now-docs with netlify-docs

Check comparison here.

License

MIT © Bu Kinoshita

now-docs's Issues

On `docs`, `i` should be uppercase

support `nowDocs` on `package.json` or `.now-docs`

custom configs

{
     name: 'app',
     alias: 'app',
     favicon: 'favicon',
     static: true
}

question: the showdown prettifier

https://github.com/showdownjs/prettify-extension

I've been trying to set this up in a fork but having trouble compiling it after adding it, will open a pr if I get it working, but I think syntax highlighting is a pretty high benefit add especially for javascript documentation.

before running, check if `docs` folder exist

support different themes

show progress when deploying

show now logs when deploying and return the url when finishes

add examples

better documentation