/docs

Documentation website for NodeCG - currently under initial development

Primary LanguageJavaScript

NodeCG Docs

These docs are built using Docusaurus 2.

The Markdown lint tool is used for linting.

Some markdown rules have been disabled:

# Rule Why
MD013 Line length
MD026 Trailing punctuation in heading Various headings in the NodeCG readme have valid question marks in the header
MD033 Inline HTML Gfycat is used to demonstrate certain concepts and they requires iframes in order to show

Installation

npm install

Local Development

npm start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

npm build

This command generates static content into the build directory and can be served using any static contents hosting service.