Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: '20'
node-version: '22'
cache: 'npm'
cache-dependency-path: docs/package-lock.json

Expand Down
71 changes: 15 additions & 56 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,66 +1,25 @@
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";
import vue from "@astrojs/vue";
import mdx from "@astrojs/mdx";
import tailwindcss from "@tailwindcss/vite";

// Starlight-based documentation site for the opencdd Ruby gem.
// opencdd-ruby documentation site.
//
// Mirrors the design of the sibling browser site at
// https://opencdd.github.io/ — same design system (Tailwind v4
// @theme tokens, paper/ink/clay/teal/lapis/hex palette, prose-opencdd
// typography), simplified for docs-only deployment.
//
// Local dev: cd docs && npm install && npm run dev
// Build: cd docs && npm run build (outputs to docs/dist/)
// Production: https://opencdd.github.io/opencdd-ruby/
//
// Deployment is automated via .github/workflows/deploy-docs.yml —
// every push to main that touches docs/ rebuilds and deploys.
export default defineConfig({
site: "https://opencdd.github.io",
base: "/opencdd-ruby",
trailingSlash: "always",
integrations: [
starlight({
title: "opencdd",
logo: {
src: "./src/assets/logo.svg",
replacesTitle: false,
},
description: "Ruby model for the IEC Common Data Dictionary",
social: {
github: "https://github.com/opencdd/opencdd-ruby",
},
sidebar: [
{
label: "Get started",
items: [
{ label: "Overview", link: "/" },
{ label: "Getting started", slug: "getting-started" },
],
},
{
label: "Concepts",
items: [
{ label: "Four-layer ontology", slug: "ontology" },
{ label: "IRDI identifiers", slug: "concepts/irdi" },
],
},
{
label: "Formats",
items: [
{ label: "YAML persistence", slug: "model/yaml-persistence" },
{ label: "Parcel Excel", slug: "parcel-format" },
{ label: "CDDAL syntax", slug: "cddal-syntax" },
],
},
{
label: "Reference",
items: [
{ label: "Architecture", slug: "architecture" },
{ label: "Feature audit", slug: "reference/features" },
{ label: "Validator rules", slug: "reference/validator-rules" },
{ label: "API", slug: "reference/api" },
],
},
],
editLink: {
baseUrl: "https://github.com/opencdd/opencdd-ruby/edit/main/docs",
},
customCss: ["./src/styles/custom.css"],
}),
],
trailingSlash: "ignore",
output: "static",
integrations: [vue(), mdx()],
vite: {
plugins: [tailwindcss()],
},
});
Loading
Loading