dgrmc / docs

📚 ØKP4 documentation portal (built with Docusaurus).

ØKP4 documentation

OKP4 documentation repository, powered ❤️ by Docusaurus, a modern static website generator.

Developing & contributing

Installation

yarn

Local Development

yarn start

This command starts a local development server and opens up a browser window (http://localhost:3000/). Most changes are reflected live without having to restart the server.

Note that the search wont work in development. To use the search feature, first run yarn build then yarn run serve.

Build

yarn build

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

Code Quality

The coding style rules are enforced by the following tools:

• Commitlint
• Markdownlint
• Prettier
• Stylelint

License

The OKP4 documentation portal is open source and 3-Clause BSD licensed.

The contents of the documentation (e.g. the .md files in the /docs folder) is Creative Commons Attribution-ShareAlike 4.0 International licensed.