shaojunda / docs

Nervos CKB Documentation, curated by Nervos Foundation, contributed by the Nervos Community with ❤️.

Nervos CKB Documentation Website

This is the Nervos CKB documentation website.

It is built with docusaurus.

Clone the Repo

git clone https://github.com/nervosnetwork/docs.git && \
cd docs && \
cd website

Install Dependencies

Install yarn.

In website folder:

yarn install

Preview the Site

In website folder:

yarn start

Then you should be able to preview the website at http://localhost:3000/ in your browser.

Build the Site

In website folder:

yarn build

The generated static files will be in website/build.

Deploy

Just serve the generated static files in website/build.

Docs

All the documents go into the docs folder. All the images should be in the docs/assets folder.

To add a document:

• add the the document to docs
• add header to the document (id and title is required)
• add the path of the folder to the website/sidebars.json file