Skip to content

Docs

These docs are built using Astro Starlight. Astro Starlight allows us to write our docs in Markdown, a simple language for adding formatting to documents. (See this guide if you are unfamiliar with it.)

For day to day editing, you will not need to install Astro or build the docs: you can use your editor’s built-in Markdown renderer to preview your changes. For VSCode, use Ctrl + Shift + V to toggle between editing and previewing.

Building

You will need Node.js >= 18.

  1. In the highest level docs directory (the one that contains the package.json), run:

    npm install
  2. Run:

    npm run build

Adding content

You can add new Markdown files in any of existing directories within src/content/docs, and Astro will find them without you needing to do any configuration.

Make sure to add a frontmatter block at the top of your Markdown files with a title and optionally a description, for example:

---
title: Jetson Development
description: A guide on how to connect to the Jetson to develop on it.
---

Adding new directories

To add a new directory under src/content/docs, configure Astro to add a new group (see the Astro docs for this).