Authoring Guide

This documentation site is built with Starlight, a documentation framework for Astro.

✍️ Authoring

Documentation is written in Markdown (.md) or MDX (.mdx).

File Location

All documentation files are located in: src/content/docs/

Frontmatter

Each file must begin with a frontmatter block:

---
title: My Page Title
description: A short description of this page.
---

Sidebars

The sidebar is configured in astro.config.mjs. When adding a new page, ensure you add it to the sidebar array if you want it to appear in the navigation.

🚀 Commands

Command	Action
./bin/preview	Starts local dev server at localhost:4321
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying

🏗️ Build & Deploy

This site is designed to be hosted on Cloudflare Pages.

1. Build: npm run build generates the static site in the dist/ folder.
2. Deploy: Push to the main branch of the blog-docs GitHub repository to trigger an automatic deployment on Cloudflare.

Sample Blog

---
title: 'My Wonderful Blog Post'
publishDate: 2025-01-01
author: Bernhard
accessLevel: public
excerpt: 'Sample Blog'
topic: blog
image: index/sample.png
draft: false
language: en
tags: ['post', 'sample']
---

Awesome new blog ...