Skip to content

feat: explanatory diagrams using d2 #98

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

Draft
xynydev wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feat: explanatory diagrams using d2 #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4dfbe7c
feat: add d2
xynydev Aug 31, 2025
d8d6e21
feat: create two (pretty disappointing) diagrams of bluebuild
xynydev Aug 31, 2025
b75e1f7
fix: don't inline the graphs
xynydev Aug 31, 2025
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ dist/
# generated types
.astro/

# d2 diagrams
public/d2/

# dependencies
node_modules/

Expand Down
1 change: 1 addition & 0 deletions .mise.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[tools]
pnpm = "9.1.0-0"
"ubi:terrastruct/d2" = "latest"

[settings]
idiomatic_version_file_enable_tools = ["node"]
257 changes: 133 additions & 124 deletions astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,142 +7,151 @@ import moduleReferencePlugin from "./src/plugins/moduleReferencePlugin";
import githubActionReferencePlugin from "./src/plugins/githubActionReferencePlugin";
import modulesJsonGeneratorPlugin from "./src/plugins/modulesJsonGeneratorPlugin";

import d2 from "astro-d2";

// 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/' },
// icon(),
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(),
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(),
},
],
}),
d2(),
],

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 @@ -25,6 +25,7 @@
"@iconify-json/ri": "^1.2.5",
"@tailwindcss/vite": "^4.1.4",
"astro": "^5.12.3",
"astro-d2": "^0.8.0",
"astro-og-canvas": "^0.4.2",
"canvaskit-wasm": "^0.39.1",
"sharp": "^0.34.3",
Expand Down
16 changes: 16 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
Loading