docs.zerotier.com

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

make start

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

Build

yarn build

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

Deployment

Commits to main are automatically deployed to https://docs-dev.zerotier.com

To promote to production, create a tag & release on GitHub. Tag/Release names should follow this format: YYYY-MM-DD-RELEASE_NUMBER. For example, the 2nd release on August 16, 204 would be 2024-08-16-2.

Spelling / Typos

yarn run lint

This is currently configured to not stop the build in CI. || true

You can add more words to ignore in the file custom-words.txt

You can ignore words in an individual markdown file like this: Make sure it's inside the front matter

---
title: Terraform (Multicloud)
# cSpell:words Hinojosa Gizienski
---

or inline

[//]: # (cspell:disable-next-line )

or add to the regexes in cspell.json. Have fun!