Skip to main content

Getting Started

Thanks for thinking of contributing to the documentation. We will describe some common workflows for the same.

Tools#

The entire stack is:

Common Concepts#

  • Do use explicit 00_name instead of using the sidebar_position key in the header
    • This is harder to keep track of locally but makes subsequent usage easier
    • Also prevents clashes
  • Do use the slug header and call it name
  • Do not use .mdx files
    • Harder to work with

Local Usage#

We prefer the usage of nvm, a Node version manager.

# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
# Install the node version used
nvm install
# Use the node version
nvm use
# Install dependencies
npm i
# Run the site (en)
npm run start
# Run the Icelandic site
npm run start -- --locale is