Development Environment

You will need Volta and pre-commit installed. If you don't have opinions about the process, this will get you going:

Copied
# Install Homebrew and everything mentioned above
bin/bootstrap

Once you have the required system dependencies:

Copied
# Install or update application dependencies
make

Now run the development webserver:

Copied
yarn start

You will now be able to access docs via http://localhost:3000.

Linting

A few linters are available. Run yarn lint to apply them all.

Additionally we use prettier to format our code. Run prettier if you get linting errors in CI:

Copied
yarn prettier:fix

If you want to run prettier on mdx and markdown files, run

Copied
yarn prettier:fix:all

Faster builds

Disable image thumbnail generation with DISABLE_THUMBNAILS=1 yarn build. Images will not work while in this mode, but builds will be significantly faster.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").