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
1 change: 1 addition & 0 deletions .custom_wordlist.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
cna
hda
passt
16 changes: 13 additions & 3 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ export default defineConfig({
/\/explanation\/index$/,
/\/reference\/index$/,
/\/contributing\/index$/,
// Ignore specific release notes pages that don't exist
/release-notes\/1592-17/,
/release-notes\/1877-11/,
/release-notes\/1877-12/,
// Ignore LICENSE files (e.g. from aggregated repos)
/LICENSE$/,
],
head: [
[
Expand Down Expand Up @@ -112,14 +118,18 @@ export default defineConfig({
editLink: {
pattern: ({ filePath, frontmatter }) => {
// If page has GitHub metadata from aggregated content, use it
if (frontmatter.github_org && frontmatter.github_repo && frontmatter.github_source_path) {
const branch = frontmatter.github_branch || 'main';
if (
frontmatter.github_org &&
frontmatter.github_repo &&
frontmatter.github_source_path
) {
const branch = frontmatter.github_branch || "main";
return `https://github.com/${frontmatter.github_org}/${frontmatter.github_repo}/edit/${branch}/${frontmatter.github_source_path}`;
}
// Fallback for pages native to docs-ng (no GitHub metadata)
return `https://github.com/gardenlinux/docs-ng/edit/main/docs/${filePath}`;
},
text: 'Edit this page on GitHub'
text: "Edit this page on GitHub",
},

search: {
Expand Down
29 changes: 27 additions & 2 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,35 @@
import { h, nextTick, watch } from 'vue'
import type { Theme } from 'vitepress'
import DefaultTheme from 'vitepress/theme'
import { useData } from 'vitepress'
import { createMermaidRenderer } from 'vitepress-mermaid-renderer'
import './style.css'
import SectionIndex from './components/SectionIndex.vue'

export default {
extends: DefaultTheme,
Layout: () => {
const { isDark } = useData()

const initMermaid = () => {
createMermaidRenderer({
// Use base theme; colors are set inline per diagram
theme: isDark.value ? 'dark' : 'default',
})
}

nextTick(() => initMermaid())

watch(
() => isDark.value,
() => {
initMermaid()
}
)

return h(DefaultTheme.Layout)
},
enhanceApp({ app }) {
app.component('SectionIndex', SectionIndex)
}
}
},
} satisfies Theme
6 changes: 6 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ hero:
- theme: alt
text: Browse Documentation
link: /overview/
- theme: alt
text: Releases
link: /reference/releases/
image:
src: /gardenlinux-logo.svg
alt: Garden Linux Logo
Expand All @@ -33,6 +36,9 @@ features:
- title: Contributing
details: Guides for contributing to Garden Linux documentation and development
link: /contributing/
- title: Releases
details: Overiew which Graden Linux Releases are available
link: /reference/releases/
# - title: Legacy Documentation
# details: Aggregated documentation from source repositories (being migrated)
# link: /projects/gardenlinux/introduction/index
Expand Down
20 changes: 20 additions & 0 deletions docs/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,26 @@ Want to try Garden Linux right now with zero setup cost?
All three tutorials run entirely on your workstation in under 5 minutes.
:::

:::danger Recommended First Tutorial
Want to try Garden Linux right now with zero setup cost?

- **Linux**: [First Boot on KVM](./local/first-boot-kvm.md) or [First Boot on Lima](./local/first-boot-lima.md)
- **macOS**: [First Boot on Lima](./local/first-boot-lima.md)
- **Any OS with Container Engine**: [First Boot as OCI Container](./container/first-boot-oci.md)

All three tutorials run entirely on your workstation in under 5 minutes.
:::

:::warning Recommended First Tutorial
Want to try Garden Linux right now with zero setup cost?

- **Linux**: [First Boot on KVM](./local/first-boot-kvm.md) or [First Boot on Lima](./local/first-boot-lima.md)
- **macOS**: [First Boot on Lima](./local/first-boot-lima.md)
- **Any OS with Container Engine**: [First Boot as OCI Container](./container/first-boot-oci.md)

All three tutorials run entirely on your workstation in under 5 minutes.
:::

<SectionIndex />

## About Tutorials
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"js-yaml": "4.1.1",
"lodash-es": "4.18.1",
"vitepress": "1.6.3",
"vitepress-mermaid-renderer": "^1.1.20",
"vitepress-sidebar": "1.31.1",
"vue": "3.5.16"
},
Expand Down
Loading
Loading