iotauth.github.io

Public website for Secure Swarm Toolkit (SST) / IoTAuth — open-source authentication and authorization for distributed systems and IoT.

Built with Docusaurus 3.

Prerequisites

• Node.js 20 or later
• Yarn

Getting Started

Install dependencies (first time only, or after pulling changes that modify package.json):

yarn install

Start the development server:

yarn start

The site opens at http://localhost:3000. The dev server hot-reloads automatically — every file save is reflected in the browser instantly without a rebuild step. Always use yarn start when editing the site.

Editing Content

Each top-level navbar tab maps to its own file:

Tab	File
Home (hero)	src/pages/index.js
Overview	src/pages/overview.mdx
Quick Start	src/pages/quickstart.mdx
Repositories	src/pages/repositories.mdx
Publications	src/pages/publications.mdx
Contributors	src/pages/contributors.mdx
Videos	src/pages/videos.mdx
Docs	docs/ (sidebar configured in sidebars.js)

Other important files:

• src/css/custom.css — all visual styles
• docusaurus.config.js — site title, navbar items, footer, plugins
• static/assets/ — images and other static files

Project Structure

├── docs/                  # Docs section pages (accessible at /docs/*)
├── src/
│   ├── css/custom.css     # Global styles
│   └── pages/             # Standalone pages (each = one navbar tab)
│       ├── index.js       # Homepage hero
│       ├── overview.mdx
│       ├── quickstart.mdx
│       ├── repositories.mdx
│       ├── publications.mdx
│       ├── contributors.mdx
│       └── videos.mdx
├── static/assets/         # Static images and other assets
├── docusaurus.config.js   # Site config: navbar, footer, plugins
└── sidebars.js            # Docs sidebar structure

Production Build

yarn start is sufficient for all local editing. Only build when you need to verify the final static output (e.g. before deploying):

yarn build        # generates static files in build/
yarn serve        # serves the build/ directory at http://localhost:3000

Note: yarn serve serves the static build/ directory and does not hot-reload. If you edit a file after running yarn build, you must run yarn build again to see the change. Use yarn start to avoid this.

Clearing the Cache

If the dev server behaves unexpectedly (missing styles, stale pages), clear the Docusaurus cache and restart:

yarn clear
yarn start