Skip to content
Starter for AwesomeDocs
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
LICENSE
README.md

README.md

AwesomeDocs Starter

This is a very basic starter for AwesomeDocs.

Install

To get started, first of all install AwesomeDocs CLI Tool globally:

npm i -g awesomedocs

Initialize

To initialize AwesomeDocs in this directory:

awesomedocs init

This will create content and static directories in this directory.

The content directory is where all your Markdown documentation lives. And what ever files you put in the static directory will be available directly from the root of your website. This is where your favicon.ico and CNAME file should go.

Serve

To serve your AwesomeDocs documentation site:

awesomedocs serve

Build

To build your AwesomeDocs documentation site for production:

awesomedocs build

This will build your site in the build directory.

You can’t perform that action at this time.