bedrockRTOS.github.io

About

Source of bedrockrtos.github.io, the website and documentation of the bedrock[RTOS] nanokernel. It is for users and contributors of bedrock-core.

Dependencies

• Node.js 22.12 or newer
• npm

Build

npm install
npm run build

The static site is written to dist/. npm run build runs astro check before the build.

Local development server:

npm run dev

Content

Documentation pages are Markdown files in src/content/docs/. Each file needs title, description and order in its frontmatter. order sets the position in the sidebar.

The landing page is src/pages/index.astro. The roadmap is src/pages/roadmap.astro and summarizes the ROADMAP.md files of bedrock-core and genesis.

Deployment

Every push to main builds the site and publishes it to GitHub Pages through .github/workflows/deploy.yml. The repository Pages source must be set to GitHub Actions.

Acknowledgments

• Astro
• Shiki for syntax highlighting

Links

• Documentation
• bedrock-core CONTRIBUTING

License

Site source code: AGPL-3.0.

Documentation text in src/content/docs/: CC BY-SA 4.0.