📄 docpage

Quickly publish documentation sites from a single markdown file.

About

With docpage a single markdown file becomes:

• a single html file with:
  • simple, readable styles
  • a sidebar with table of contents
  • links in the header to git repo and main project website
• an instant documentation site on docpage.org (optional)

Install

npm install -g docpage

docpage requires Node.js and npm. Install Node.js if you haven't already.

Command-line usage

Build the index.html file from a markdown file:

docpage build example.md > site/index.html

Watch for changes and rebuild:

docpage build example.md > site/index.html --watch

Put project description in header

docpage build example.md > site/index.html --description "simple docs site from a markdown file"

Put git repo and main website links in header

docpage build example.md > site/index.html --code https://github.com/sethvincent/docpage --main-website http://sethvincent.com

Start a development server

docpage start example.md

Watch for change and rebuild

docpage start example.md --watch

Publish a markdown file to docpage.org

docpage register
docpage publish example.md example-docpage-site

Full command-line help text

USAGE:
  docpage {command} [options]

COMMANDS:
  publish     publish a page
  build       build page,
  start       serve a page locally
  register    create an account on docpage.org
  login       log in to docpage.org
  help        show this help message

BUILD
  docpage build file.md

  Options:
  -o, --output          the filepath of the html file you want to create
  -w, --watch           watch the markdown file for changes and rebuild
  -c, --code            link to code repository
  -m, --main-website    link to main website for project

START
  docpage start file.md

  Options:
  -o, --output          the filepath of the html file you want to create
  -w, --watch           watch the markdown file for changes and rebuild
  -c, --code            link to code repository
  -m, --main-website    link to main website for project

PUBLISH
  docpage publish file.md name-of-project

LOGIN
  docpage login

REGISTER
  docpage register

HELP
  docpage help

JavaScript module usage

var fs = require('fs')
var path = require('path')
var docpage = require('docpage')

var input = path.join(__dirname, 'example.md')
var output = path.join(__dirname, 'index.html')

var options = {
  output: output,
  title: 'docpage'
}

docpage.build(input, options, function (err, file) {
  if (err) console.log(err)
})

Open source

docpage is open source and based on Node.js and these projects:

• township – open source tools for auth
• appa – a small framework for quickly creating JSON API servers
• bel – a simple library for composable DOM elements using tagged template strings

See also

• minidocs – build a minimalist site for your documentation (more features than docpage)
• static.land – static site hosting with SSL via Let's Encrypt

Contributing

Contributions are welcome! Please read the contributing guidelines first.

Conduct

It's important that this project contributes to a friendly, safe, and welcoming environment for all, particularly for folks that are historically underrepresented in technology. Read this project's code of conduct

Change log

Read about the changes to this project in CHANGELOG.md. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Contact

• issues – Please open issues in the issues queue
• twitter – @sethdvincent
• email – Need in-depth support via paid contract? Send an email to [email protected]

License

ISC