-
Notifications
You must be signed in to change notification settings - Fork 1
Quickstart
Tyler Benton edited this page Sep 27, 2016
·
1 revision
- First let's create a sample directory:
mkdir try-docs
cd try-docs/- Start a new node project and install
docs-coreanddocs-theme-default:
npm init --yes
...
npm i docs-core docs-theme-default --save-dev- Create a
docsfile.js
module.exports = {
theme: 'default'
}- Create a
README.md
<!----
@name Try Docs
@page home
@markdown
---->
# WOOHOO
Trying docs for the first time- Start the docs server
docs serverthen 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