Skip to content

Quickstart

Tyler Benton edited this page Sep 27, 2016 · 1 revision

Docs Quickstart

  1. First let's create a sample directory:
mkdir try-docs
cd try-docs/
  1. Start a new node project and install docs-core and docs-theme-default:
npm init --yes
...
npm i docs-core docs-theme-default --save-dev
  1. Create a docsfile.js
module.exports = {
  theme: 'default'
}
  1. Create a README.md
<!----
@name Try Docs
@page home
@markdown
---->

# WOOHOO

Trying docs for the first time
  1. Start the docs server
docs server

then go to http://localhost:4444

To see more things you can document see docs-plugin-default-annotations

For a more in-depth example see docs-example

Clone this wiki locally