gr-apollo/docs/astro.config.mjs
Ryan Malloy 12fb284d5f Add Starlight documentation site with diataxis structure
14 content pages across four diataxis categories:
- Getting Started: introduction, installation, quick-start tutorial
- Understanding Apollo USB: signal architecture, PCM frame structure, AGC integration
- How-To Guides: tuning parameters, test signals, voice audio, AGC bridge, PCM telemetry
- Reference: block reference (all 16 blocks), constants, protocol specification

Includes Mermaid diagram support via rehype-mermaid with client-side
rendering, dark theme, Pagefind search index, and edit-on-GitHub links.
2026-02-20 15:26:05 -07:00

65 lines
2.2 KiB
JavaScript

// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import rehypeMermaid from 'rehype-mermaid';
export default defineConfig({
integrations: [
starlight({
title: 'gr-apollo',
description: 'Apollo Unified S-Band decoder for GNU Radio 3.10+',
social: [
{ icon: 'github', label: 'GitHub', href: 'https://github.com/rpm/gr-apollo' },
],
sidebar: [
{
label: 'Getting Started',
items: [
{ label: 'Introduction', slug: 'getting-started/introduction' },
{ label: 'Installation', slug: 'getting-started/installation' },
{ label: 'Quick Start', slug: 'getting-started/quick-start' },
],
},
{
label: 'Understanding Apollo USB',
items: [
{ label: 'Signal Architecture', slug: 'explanation/signal-architecture' },
{ label: 'PCM Frame Structure', slug: 'explanation/pcm-frames' },
{ label: 'Virtual AGC Integration', slug: 'explanation/virtual-agc' },
],
},
{
label: 'How-To Guides',
items: [
{ label: 'Tune Demodulator Parameters', slug: 'guides/tuning-parameters' },
{ label: 'Generate Test Signals', slug: 'guides/test-signals' },
{ label: 'Decode Voice Audio', slug: 'guides/voice-audio' },
{ label: 'Connect to Virtual AGC', slug: 'guides/agc-bridge' },
{ label: 'Work with PCM Telemetry', slug: 'guides/pcm-telemetry' },
],
},
{
label: 'Reference',
items: [
{ label: 'Block Reference', slug: 'reference/blocks' },
{ label: 'Constants & Parameters', slug: 'reference/constants' },
{ label: 'Protocol Specification', slug: 'reference/protocol' },
],
},
],
editLink: {
baseUrl: 'https://github.com/rpm/gr-apollo/edit/main/docs/',
},
components: {
Head: './src/components/Head.astro',
},
}),
],
markdown: {
rehypePlugins: [
[rehypeMermaid, { strategy: 'pre-mermaid' }],
],
},
devToolbar: { enabled: false },
});