Skip to content

refactor: better jsonschema docs generation #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xynydev merged 4 commits into from
Jan 30, 2026
Merged

refactor: better jsonschema docs generation #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a421256
refactor: better jsonschema docs generation
xynydev Jan 5, 2026
9ae902a
refactor: better string generation and hierarchy
xynydev Jan 24, 2026
2cb7192
feat: generate recipe docs with recipe schema
xynydev Jan 26, 2026
b396134
fix: support static enums (used by platforms[]:)
xynydev Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@ pnpm-debug.log*
public/modules.json
src/content/docs/reference/modules/
src/content/docs/reference/github-action.md
src/content/docs/reference/recipe.mdx

.wrangler
256 changes: 132 additions & 124 deletions astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,143 +6,151 @@ import tailwindcss from "@tailwindcss/vite";
import moduleReferencePlugin from "./src/plugins/moduleReferencePlugin";
import githubActionReferencePlugin from "./src/plugins/githubActionReferencePlugin";
import modulesJsonGeneratorPlugin from "./src/plugins/modulesJsonGeneratorPlugin";
import recipeReferencePlugin from "./src/plugins/recipeReferencePlugin";

// https://astro.build/config
export default defineConfig({
site: "https://blue-build.org/",

integrations: [
starlight({
title: "BlueBuild",
logo: {
replacesTitle: true,
dark: "./src/assets/logo-dark.svg",
light: "./src/assets/logo-light.svg",
alt: "BlueBuild. A minimal logo with a blue-billed duck holding a golden wrench in its beak.",
},
editLink: {
baseUrl: "https://github.com/blue-build/website/edit/main/",
},
social: [
{ icon: 'github', label: 'GitHub', href: 'https://github.com/blue-build/' },
starlight({
title: "BlueBuild",
logo: {
replacesTitle: true,
dark: "./src/assets/logo-dark.svg",
light: "./src/assets/logo-light.svg",
alt: "BlueBuild. A minimal logo with a blue-billed duck holding a golden wrench in its beak.",
},
editLink: {
baseUrl: "https://github.com/blue-build/website/edit/main/",
},
social: [
{
icon: "github",
label: "GitHub",
href: "https://github.com/blue-build/",
},
],
sidebar: [
{
label: "Learn",
items: [
{
label: "Getting started",
link: "/learn/getting-started/",
},
{
label: "Thinking like a distribution",
link: "/learn/mindset/",
},
{
label: "Building on Universal Blue",
link: "/learn/universal-blue/",
},
{
label: "How BlueBuild works",
link: "/learn/how/",
},
{
label: "Troubleshooting, reporting bugs, and common issues",
link: "/learn/troubleshooting/",
},
{
label: "Contributing",
link: "/learn/contributing/",
},
{
label: "Scope",
link: "/learn/scope/",
},
],
sidebar: [
{
label: "Learn",
items: [
{
label: "Getting started",
link: "/learn/getting-started/",
},
{
label: "Thinking like a distribution",
link: "/learn/mindset/",
},
{
label: "Building on Universal Blue",
link: "/learn/universal-blue/",
},
{
label: "How BlueBuild works",
link: "/learn/how/",
},
{
label: "Troubleshooting, reporting bugs, and common issues",
link: "/learn/troubleshooting/",
},
{
label: "Contributing",
link: "/learn/contributing/",
},
{
label: "Scope",
link: "/learn/scope/",
},
],
},
{
label: "How-to",
autogenerate: {
directory: "how-to",
},
},
{
label: "Reference",
items: [
{
label: "recipe.yml",
link: "/reference/recipe/",
},
{
label: "blue-build/github-action",
link: "/reference/github-action/",
},
{
label: "Module",
link: "/reference/module/",
},
{
label: "Stages",
link: "/reference/stages/",
},
{
label: "Modules",
autogenerate: {
directory: "reference/modules",
},
},
],
},
{
label: "How-to",
autogenerate: {
directory: "how-to",
},
},
{
label: "Reference",
items: [
{
label: "recipe.yml",
link: "/reference/recipe/",
},
{
label: "blue-build/github-action",
link: "/reference/github-action/",
},
{
label: "Module",
link: "/reference/module/",
},
{
label: "Stages",
link: "/reference/stages/",
},
{
label: "Modules",
autogenerate: {
directory: "reference/modules",
},
},
],
plugins: [
modulesJsonGeneratorPlugin({
moduleSources: [
{
source: "https://api.github.com/repos/blue-build/modules/contents/modules",
},
{
source: "https://api.github.com/repos/blue-build/cli/contents/template/templates/modules",
},
],
}),
moduleReferencePlugin(),
githubActionReferencePlugin({
source: "https://raw.githubusercontent.com/blue-build/github-action/main/action.yml",
path: "reference/github-action.md",
}),
],
customCss: [
"@fontsource/atkinson-hyperlegible/400.css",
"@fontsource/atkinson-hyperlegible/700.css",
"@fontsource-variable/rubik",
"@fontsource/ibm-plex-mono",
"./src/styles/global.css",
},
],
plugins: [
modulesJsonGeneratorPlugin({
moduleSources: [
{
source:
"https://api.github.com/repos/blue-build/modules/contents/modules",
},
{
source:
"https://api.github.com/repos/blue-build/cli/contents/template/templates/modules",
},
],
components: {
SocialIcons: "./src/components/NavLinks.astro",
Hero: "./src/components/Hero.astro",
Footer: "./src/components/Footer.astro",
Head: "./src/components/Head.astro",
Search: "./src/components/Search.astro",
Sidebar: "./src/components/Sidebar.astro",
MarkdownContent: "./src/components/MarkdownContent.astro",
}),
moduleReferencePlugin(),
recipeReferencePlugin(),
githubActionReferencePlugin({
source:
"https://raw.githubusercontent.com/blue-build/github-action/main/action.yml",
path: "reference/github-action.md",
}),
],
customCss: [
"@fontsource/atkinson-hyperlegible/400.css",
"@fontsource/atkinson-hyperlegible/700.css",
"@fontsource-variable/rubik",
"@fontsource/ibm-plex-mono",
"./src/styles/global.css",
],
components: {
SocialIcons: "./src/components/NavLinks.astro",
Hero: "./src/components/Hero.astro",
Footer: "./src/components/Footer.astro",
Head: "./src/components/Head.astro",
Search: "./src/components/Search.astro",
Sidebar: "./src/components/Sidebar.astro",
MarkdownContent: "./src/components/MarkdownContent.astro",
},
head: [
{
tag: "script",
attrs: {
defer: true,
src: "https://eu.umami.is/script.js",
"data-website-id": "fdbab42b-cab4-4f46-b06a-172700ea1e1c",
},
head: [
{
tag: "script",
attrs: {
defer: true,
src: "https://eu.umami.is/script.js",
"data-website-id":
"fdbab42b-cab4-4f46-b06a-172700ea1e1c",
},
},
],
})
// icon(),
},
],
}),
// icon(),
],

vite: {
plugins: [tailwindcss()],
},
});
});
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"eslint-plugin-mdx": "^3.4.1",
"eslint-plugin-n": "^16.6.2",
"eslint-plugin-promise": "^6.6.0",
"json-schema-typed": "^8.0.2",
"markdown-it": "^14.1.0",
"prettier": "3.2.5",
"prettier-plugin-astro": "^0.13.0",
Expand Down
8 changes: 8 additions & 0 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading