1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-14 00:53:49 +01:00
RIOT/doc/starlight/astro.config.mjs
AnnsAnn 8cdb2d9411 doc/guides: Riot Tutorial
examples/guides: Introduce tutorial references

doc/guides/tutorial: Introduce code_folder for all tutorials
2025-06-26 15:53:58 +02:00

103 lines
2.7 KiB
JavaScript

// @ts-check
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";
// https://astro.build/config
export default defineConfig({
site: "https://guide.riot-os.org",
integrations: [
starlight({
title: "Riot Documentation",
social: [
{
icon: "github",
label: "GitHub",
href: "https://github.com/riot-os/riot",
},
{
icon: "mastodon",
label: "Mastodon",
href: "https://fosstodon.org/@RIOT_OS",
},
{
icon: "matrix",
label: "Matrix",
href: "https://matrix.to/#/#riot-os:matrix.org",
},
],
sidebar: [
{
label: "External Documentation",
items: [
{
label: "API Documentation",
link: "https://doc.riot-os.org",
badge: { text: "Doxygen", variant: "tip" },
},
{
label: "Rust Documentation",
link: "https://doc.riot-os.org/rustdoc/latest/riot_doc_helpers/",
badge: { text: "Rustdoc", variant: "tip" },
},
],
},
{
label: "RIOT in a Nutshell",
items: [
{ label: "Introduction", slug: "index" },
"general/structure",
],
},
{
label: "Tutorials",
items: [
{
label: "Getting Started",
items: [
"getting-started/install-wsl",
"getting-started/installing",
"getting-started/flashing",
"getting-started/building_example",
"getting-started/finding_modules",
],
},
{
label: "C Basics",
items: [
"c_tutorials/create_project",
"c_tutorials/timers",
"c_tutorials/shell",
"c_tutorials/threads",
"c_tutorials/gpio",
"c_tutorials/saul",
],
},
],
},
{
label: "Build System",
items: [
"build-system/build_system",
"build-system/build_system_basics",
"build-system/build-in-docker",
"build-system/advanced_build_system_tricks",
],
},
{
label: "Miscellaneous",
items: ["misc/how_to_doc"],
},
],
customCss: [],
logo: {
src: "./src/assets/riot-logo.svg",
replacesTitle: true,
},
plugins: [],
editLink: {
baseUrl: "https://github.com/RIOT-OS/RIOT/tree/master/doc/guides",
},
}),
],
});