designemail / website

The website of AwesomeDocs

AwesomeDocs Website

This is the website of AwesomeDocs, made with AwesomeDocs!

Clone

Clone this repository using:

git clone https://github.com/AwesomeDocs/website.git

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.