Skip to main content

Getting started

This guide gets the site running on your machine and walks through the edit → preview → publish loop.

Prerequisites​

  • Node.js 20 or newer — check with node --version
  • npm — ships with Node

Run it locally​

npm install
npm start

The dev server opens localhost:3000 and hot-reloads on save. Most content edits appear without a restart; changes to docusaurus.config.ts need one.

Edit a page​

Every page maps to a file on disk:

URLSource folder
/src/pages/
/portfolio/docs/portfolio/
/docs/docs/main/
/<category>/<id>/next/docs/<category>/<id>/ (unreleased)
/<category>/<id>/<id>_versioned_docs/ (latest release)
/blogblog/

Create a new guide by adding a Markdown file under docs/main/ with front matter:

---
id: my-guide
title: My guide
sidebar_position: 3
description: One line shown in search results and previews.
---

# My guide

The sidebar is generated from the folder structure, so the file appears automatically — sidebar_position controls where.

Check it before pushing​

npm run typecheck && npm run lint && npm run build

npm run build is the important one: it fails on broken internal links, which the dev server tolerates.

Publish​

Push to main. The GitHub Actions workflow builds the site and deploys it to GitHub Pages.

One-time setup

In the repository settings, under Pages → Build and deployment, set Source to GitHub Actions. Without that, the workflow builds but nothing goes live.

Next steps​