+ {@render children()}
+
+
+
- :construction_worker: **Platform-provided secrets**
---
@@ -22,6 +23,7 @@ There are two types of secrets on the Nais platform:
+
- :technologist: **User-defined secrets**
---
diff --git a/docs/services/secrets/how-to/console.md b/docs/services/secrets/how-to/console.md
index 228c4ca9..677835d6 100644
--- a/docs/services/secrets/how-to/console.md
+++ b/docs/services/secrets/how-to/console.md
@@ -12,7 +12,7 @@ This how-to guide shows you how to create and manage a [secret](../README.md) in
## List secrets
-1. Open [Nais console :octicons-link-external-16:](https://console.<>.cloud.nais.io) in your browser
+1. Open [Nais console](https://console.<>.cloud.nais.io) in your browser
2. Select your team
3. Select the `Secrets` tab
diff --git a/docs/services/secrets/reference/README.md b/docs/services/secrets/reference/README.md
index 74234bce..cdfa5194 100644
--- a/docs/services/secrets/reference/README.md
+++ b/docs/services/secrets/reference/README.md
@@ -8,7 +8,7 @@ This is the reference documentation for [secrets](../README.md) on the Nais plat
## Console
-Visit [Nais Console :octicons-link-external-16:](https://console.<>.cloud.nais.io) to find and manage your team's user-defined secrets.
+Visit [Nais Console](https://console.<>.cloud.nais.io) to find and manage your team's user-defined secrets.
## Workloads
diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md
index 944884e6..f32a14f5 100644
--- a/docs/tutorials/README.md
+++ b/docs/tutorials/README.md
@@ -12,10 +12,10 @@ Tutorials are lessons that focuses on _learning by doing_.
These give you hands-on experience with various parts of Nais, where we carefully guide you each step of the way.
>.cloud.nais.io) in your browser
+1. Open [Nais console](https://console.<>.cloud.nais.io) in your browser
2. Select your team
3. Select the `Apps` tab
4. Select the application that you want to delete
diff --git a/docs/workloads/job/how-to/delete.md b/docs/workloads/job/how-to/delete.md
index 32166587..3a70b3b3 100644
--- a/docs/workloads/job/how-to/delete.md
+++ b/docs/workloads/job/how-to/delete.md
@@ -10,7 +10,7 @@ tags: [job, how-to]
## Delete your job
-1. Open [Nais console :octicons-link-external-16:](https://console.<>.cloud.nais.io) in your browser
+1. Open [Nais console](https://console.<>.cloud.nais.io) in your browser
2. Select your team
3. Select the `Job` tab
4. Select the job that you want to delete
diff --git a/svdoc/.env.example b/svdoc/.env.example
new file mode 100644
index 00000000..c491b95c
--- /dev/null
+++ b/svdoc/.env.example
@@ -0,0 +1,5 @@
+# Tenant configuration
+# The tenant name (e.g., "nav", "test-nais")
+TENANT=nav
+NOT_TENANT=not-nav
+CONTENT_STORE_LOG_LEVEL=info
diff --git a/svdoc/.gitignore b/svdoc/.gitignore
new file mode 100644
index 00000000..3b462cb0
--- /dev/null
+++ b/svdoc/.gitignore
@@ -0,0 +1,23 @@
+node_modules
+
+# Output
+.output
+.vercel
+.netlify
+.wrangler
+/.svelte-kit
+/build
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Env
+.env
+.env.*
+!.env.example
+!.env.test
+
+# Vite
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
diff --git a/svdoc/.npmrc b/svdoc/.npmrc
new file mode 100644
index 00000000..b6f27f13
--- /dev/null
+++ b/svdoc/.npmrc
@@ -0,0 +1 @@
+engine-strict=true
diff --git a/svdoc/.prettierignore b/svdoc/.prettierignore
new file mode 100644
index 00000000..7d74fe24
--- /dev/null
+++ b/svdoc/.prettierignore
@@ -0,0 +1,9 @@
+# Package Managers
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+bun.lock
+bun.lockb
+
+# Miscellaneous
+/static/
diff --git a/svdoc/.prettierrc b/svdoc/.prettierrc
new file mode 100644
index 00000000..7e71c41a
--- /dev/null
+++ b/svdoc/.prettierrc
@@ -0,0 +1,15 @@
+{
+ "useTabs": true,
+ "singleQuote": false,
+ "trailingComma": "all",
+ "printWidth": 100,
+ "plugins": ["prettier-plugin-svelte", "prettier-plugin-tailwindcss"],
+ "overrides": [
+ {
+ "files": "*.svelte",
+ "options": {
+ "parser": "svelte"
+ }
+ }
+ ]
+}
diff --git a/svdoc/.vscode/settings.json b/svdoc/.vscode/settings.json
new file mode 100644
index 00000000..bc31e155
--- /dev/null
+++ b/svdoc/.vscode/settings.json
@@ -0,0 +1,5 @@
+{
+ "files.associations": {
+ "*.css": "tailwindcss"
+ }
+}
diff --git a/svdoc/INSTRUCTIONS.md b/svdoc/INSTRUCTIONS.md
new file mode 100644
index 00000000..8fb0beef
--- /dev/null
+++ b/svdoc/INSTRUCTIONS.md
@@ -0,0 +1,231 @@
+# Svelte Markdown Renderer Instructions
+
+## Documentation Source
+
+The markdown documentation files are located in the `docs/` directory at the repository root (relative path from svdoc: `../docs/`).
+
+## Architecture
+
+This project implements a custom Svelte-based markdown renderer using the `marked` library. Instead of rendering markdown to HTML strings, we parse it into tokens and render them as Svelte components.
+
+### Token Flow
+
+1. **Parsing**: `src/lib/markdown.ts` uses `Marked` to parse markdown into a token stream
+2. **Processing**: Custom extensions and post-processing handle emojis, HTML blocks with `markdown` attribute, and footnotes
+3. **Rendering**: `Renderer.svelte` maps token types to Svelte components recursively
+
+## Custom Marked Extensions
+
+### Emoji Extension
+
+Converts `:emoji_name:` shortcodes to native emoji characters (e.g., `:wave:` β π). Uses `emoji-name-map` for the conversion. Implemented as an inline tokenizer extension.
+
+### Footnote Extension
+
+Custom implementation (not using `marked-footnote`) with two parts:
+
+- `footnoteRef` (inline): Parses `[^1]` references
+- `footnote` (block): Parses `[^1]: content` definitions
+
+The `processFootnotes()` function collects all footnote definitions and moves them to the end wrapped in a `footnotes` token.
+
+### HTML with Markdown Attribute
+
+Material for MkDocs uses `
-- :octicons-rocket-24:{ .lg .middle } [**Hello Nais**](./hello-nais.md)
+
+- :rocket: [**Hello Nais**](./hello-nais.md)
---
-
Get your first application up and running on Nais.
diff --git a/docs/workloads/application/how-to/delete.md b/docs/workloads/application/how-to/delete.md
index 69bec602..8b50d1fb 100644
--- a/docs/workloads/application/how-to/delete.md
+++ b/docs/workloads/application/how-to/delete.md
@@ -10,7 +10,7 @@ tags: [application, how-to]
## Delete your application
-1. Open [Nais console :octicons-link-external-16:](https://console.<` to indicate the div's content should be parsed as markdown. The `processHtmlMarkdownBlocks()` function:
+
+1. Detects opening tags with `markdown` attribute
+2. Finds the matching closing tag
+3. Combines into a single `html_with_markdown` token with `openTag`, `closeTag`, and `innerTokens`
+
+The `HtmlWithMarkdown.svelte` renderer uses `` to render the correct tag with extracted class/id attributes.
+
+## Renderer Components
+
+Each markdown token type maps to a Svelte component in `src/lib/renderers/`. The main `Renderer.svelte` component maintains a map of token types to components and recursively renders nested tokens.
+
+### Key Implementation Notes
+
+- **Hydration**: Avoid separate `{@html}` calls for opening/closing tags - use actual elements or `` to prevent hydration mismatches
+- **Invalid Attributes**: The `markdown` attribute must be stripped from HTML as browsers remove it client-side, causing hydration errors
+- **List Items**: Use native `
- `/`
- ` elements for markdown lists, as ds-svelte-community's List/ListItem have different semantics
+- **Each Blocks**: Always use keyed `{#each}` blocks (e.g., `{#each items as item, i (i)}`)
+
+## Design System Integration
+
+Uses `@nais/ds-svelte-community` components where appropriate:
+
+- `Heading` for headings (with dynamic `as` and `size` props)
+- `BodyLong` for paragraphs
+- `Alert` for blockquotes
+- `List` and `ListItem` for lists
+- `Table`, `Thead`, `Tbody`, `Tr`, `Th`, `Td` for tables
+- `CopyButton` in code blocks
+
+Regular `` elements are used for links.
+
+## MkDocs Material Compatibility
+
+This renderer supports several Material for MkDocs features:
+
+### Admonitions
+
+Supports `!!!`, `???`, and `???+` syntax for notes, warnings, etc:
+
+- `!!! note "Title"` - Regular admonition
+- `??? note "Title"` - Collapsible (closed)
+- `???+ note "Title"` - Collapsible (open by default)
+
+### Content Tabs
+
+Supports `=== "Tab Title"` syntax with indented content.
+
+### Code Annotations
+
+Supports inline code annotations using comment syntax:
+
+- `# (1)` or `// (1)` - Annotation marker (hover to reveal)
+- `# Replace (1)` - Text before marker is preserved in output
+- `#(1)!` - The `!` suffix strips the entire comment
+
+Annotations link to numbered lists following the code block.
+
+## Syntax Highlighting
+
+Uses Shiki for server-side syntax highlighting with dual theme support (light/dark).
+
+### Code Fence Options
+
+- Language: ` ```yaml `
+- Line highlighting: ` ```yaml hl_lines="4-5 8" `
+- Title: ` ```yaml title="config.yaml" `
+
+Highlighting is processed at build time via `src/lib/helpers/shiki.ts`.
+
+## Navigation System
+
+Navigation is built from the `../docs` directory structure in `src/lib/navigation.ts`.
+
+### .pages Files
+
+Supports MkDocs-style `.pages` files for navigation configuration:
+
+- `nav:` - Ordered list of items
+- `hide: true` - Exclude directory from navigation
+- `...` - Include all unlisted items at that position
+- Explicit titles: `{ "Display Name": "path" }`
+
+### Directory Handling
+
+- Directories use their name as the nav title (not README heading)
+- `hasContent` is true only if directory contains README.md
+- Items without content render as text, not links
+
+## Editable Variables
+
+The renderer supports editable placeholder variables in both inline code and code blocks.
+
+### Syntax
+
+- `
` - Editable variable (uppercase letters, underscores, hyphens) +- ` +``` + +Users can click on ` ` to enter their actual namespace value, which persists across all instances on the page. + +## Svelte MCP Server + +This project uses the Svelte MCP (Model Context Protocol) server for AI-assisted development. The MCP server provides comprehensive Svelte 5 and SvelteKit documentation and code analysis. + +### Available Tools + +1. **list-sections** - Discover all available documentation sections. Use this FIRST when asked about Svelte topics. + +2. **get-documentation** - Retrieves full documentation for specific sections. After list-sections, analyze the `use_cases` field and fetch ALL relevant sections at once. + +3. **svelte-autofixer** - Analyzes Svelte code and returns issues/suggestions. MUST be used when writing Svelte code before sending to the user. + +4. **playground-link** - Generates a Svelte Playground link. Only use after user confirms they want one, and NEVER if code was written to project files. + +### Key Svelte 5 Patterns + +- **Use `$effect` instead of `onMount`** for DOM manipulation after render. Effects re-run when their dependencies change and include cleanup via return function. +- **`onMount` only runs once** and doesn't track reactive dependencies - use `$effect` when you need reactivity. +- **`$effect` runs after DOM updates** in a microtask, making it ideal for mounting imperative components into rendered HTML. +- **Track dependencies explicitly** - `$effect` only tracks values read synchronously in its body. Values read after `await` or in `setTimeout` are not tracked. + +### Example: Mounting Components into Rendered HTML + +```svelte + + + + {@html someHtmlWithMarkers} ++``` + +## Template Processing + +The `src/lib/helpers/templates.ts` module processes Jinja-like templates: + +### Variables + +- `<%sveltekit.body%+ + diff --git a/svdoc/src/css/app.css b/svdoc/src/css/app.css new file mode 100644 index 00000000..b118dfb4 --- /dev/null +++ b/svdoc/src/css/app.css @@ -0,0 +1,161 @@ +@layer theme, base, components, utilities; + +@import "./variables.css"; +@import "tailwindcss/theme.css" layer(theme); +@import "tailwindcss/utilities.css" layer(utilities); +@import "@nais/ds-svelte-community/css" layer(components); + +body { + min-height: 100vh; +} + +/* Inline icons styling */ +.emoji-icon { + display: inline-flex; + height: 1.125em; + vertical-align: text-top; +} + +.emoji-icon svg { + fill: currentColor; + height: 100%; + width: auto; +} + +/* Emoji font stack for consistent rendering across platforms */ +.emoji { + font-family: + "Apple Color Emoji", "Segoe UI Emoji", "Noto Color Emoji", "Twemoji Mozilla", "Android Emoji", + sans-serif; + font-style: normal; + font-weight: normal; + line-height: 1; +} + +/* Scrollbar styling for Firefox */ +.scrollbar-thin { + scrollbar-width: thin; + scrollbar-color: var(--ax-border-neutral-subtle, rgba(175, 184, 193, 0.3)) transparent; +} + +/* Scrollbar styling for Webkit browsers */ +.scrollbar-thin::-webkit-scrollbar { + width: 4px; +} + +.scrollbar-thin::-webkit-scrollbar-track { + background: transparent; +} + +.scrollbar-thin::-webkit-scrollbar-thumb { + background-color: var(--ax-border-neutral-subtle, rgba(175, 184, 193, 0.3)); + border-radius: 2px; +} + +.scrollbar-thin::-webkit-scrollbar-thumb:hover { + background-color: var(--ax-border-neutral, rgba(175, 184, 193, 0.5)); +} + +/* Grid cards styling for Material for MkDocs compatibility */ +.grid.cards > div > ul { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(16rem, 1fr)); + gap: 1rem; + list-style: none; + padding: 0; + margin: 1.5rem 0; +} + +@media (max-width: 600px) { + .grid.cards > ul { + grid-template-columns: 1fr; + } +} + +.grid.cards > div > ul > li { + padding: 1rem; + border: 1px solid var(--ax-border-neutral-subtle, rgba(175, 184, 193, 0.3)); + border-radius: 0.5rem; + background-color: var(--ax-bg-neutral-soft, rgba(175, 184, 193, 0.05)); + transition: all 0.2s; +} + +.grid.cards > div > ul > li:hover { + border-color: var(--ax-border-accent, rgba(0, 103, 197, 0.5)); + background-color: var(--ax-bg-accent-soft, rgba(0, 103, 197, 0.1)); + transform: translateY(-2px); + box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1); +} + +/* Hide list markers in grid cards */ +.grid.cards > div > ul > li .aksel-list__item-marker { + display: none; +} + +.grid.cards > div > ul > li .emoji-icon { + margin-right: 0.5rem; +} + +/* Consistent top margin for headings */ +/*h1, +h2, +h3, +h4, +h5, +h6 { + margin-top: 1.5em; +} +*/ + +h1:first-child, +h2:first-child, +h3:first-child, +h4:first-child, +h5:first-child, +h6:first-child { + margin-top: 0; +} + +/* Content spacing using lobotomized owl selector */ +/* Apply to content-flow containers for consistent spacing between elements */ +.content-flow > * { + margin-top: 0; + margin-bottom: 0; +} + +.content-flow > * + * { + margin-top: 1rem; +} + +/* Headings need more space above them */ +.content-flow > * + :is(h1, h2, h3, h4, h5, h6) { + margin-top: 1.5em; +} + +/* External link icon for links that open in new tab */ +a[target="_blank"]:not(.no-icon)::after, +a[href^="http"]:not([href*="nais.io"]):not(.no-icon)::after { + content: ""; + display: inline-block; + width: 0.75em; + height: 0.75em; + margin-left: 0.25em; + vertical-align: middle; + background-color: currentColor; + mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6'/%3E%3Cpolyline points='15 3 21 3 21 9'/%3E%3Cline x1='10' y1='14' x2='21' y2='3'/%3E%3C/svg%3E"); + mask-size: contain; + mask-repeat: no-repeat; + -webkit-mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6'/%3E%3Cpolyline points='15 3 21 3 21 9'/%3E%3Cline x1='10' y1='14' x2='21' y2='3'/%3E%3C/svg%3E"); + -webkit-mask-size: contain; + -webkit-mask-repeat: no-repeat; +} + +.grid.cards a:not(.unstyled) { + display: inline; +} + +/* Break long code spans in table cells */ +td code, +th code { + word-break: break-all; +} diff --git a/svdoc/src/css/variables.css b/svdoc/src/css/variables.css new file mode 100644 index 00000000..02757d7c --- /dev/null +++ b/svdoc/src/css/variables.css @@ -0,0 +1,58 @@ +/* + * Svdoc Layout Variables + * + * These CSS custom properties define the core layout dimensions and breakpoints. + * Use these variables throughout the application for consistent sizing. + */ + +:root { + /* Header */ + --svdoc-header-height: 48px; + + /* Sidebar */ + --svdoc-sidebar-width: 280px; + --svdoc-sidebar-width-narrow: 240px; + --svdoc-sidebar-width-mobile: 280px; + + /* Table of Contents */ + --svdoc-toc-width: 250px; + + /* Content */ + --svdoc-content-max-width: 1000px; + --svdoc-content-max-width-narrow: 900px; + + /* Spacing */ + --svdoc-content-padding: 2rem 2rem 1.5rem 2rem; + --svdoc-content-padding-narrow: 1.5rem; + --svdoc-content-padding-mobile: 1.5rem 1rem; + + /* Transitions */ + --svdoc-transition-duration: 0.3s; + --svdoc-transition-timing: ease; +} + +/* + * Tailwind v4 Custom Breakpoints + * + * These extend Tailwind's default breakpoints with svdoc-specific breakpoints. + * + * Usage in Svelte component + * + * Usage with Tailwind utility classes: + * class="svdoc-sidebar-collapse:hidden" + * + * Breakpoint behavior: + * > 1300px: Full layout (sidebar + content + TOC) + * β€ 1300px: Sidebar toggleable, content expands left + * β€ 1000px: TOC hidden, content expands right + * β€ 768px: Mobile layout (smaller padding) + */ +@theme { + --breakpoint-svdoc-sidebar-collapse: 1300px; + --breakpoint-svdoc-toc-hide: 1000px; + --breakpoint-svdoc-mobile: 768px; +} diff --git a/svdoc/src/lib/NavItem.svelte b/svdoc/src/lib/NavItem.svelte new file mode 100644 index 00000000..460ded3d --- /dev/null +++ b/svdoc/src/lib/NavItem.svelte @@ -0,0 +1,241 @@ + + + + + diff --git a/svdoc/src/lib/SearchButton.svelte b/svdoc/src/lib/SearchButton.svelte new file mode 100644 index 00000000..825f7000 --- /dev/null +++ b/svdoc/src/lib/SearchButton.svelte @@ -0,0 +1,46 @@ + + ++ + Search + {shortcutKey}+K + + + diff --git a/svdoc/src/lib/SearchModal.svelte b/svdoc/src/lib/SearchModal.svelte new file mode 100644 index 00000000..8891985b --- /dev/null +++ b/svdoc/src/lib/SearchModal.svelte @@ -0,0 +1,387 @@ + + ++ {#snippet header()} + + + diff --git a/svdoc/src/lib/Sidebar.svelte b/svdoc/src/lib/Sidebar.svelte new file mode 100644 index 00000000..234cd8f1 --- /dev/null +++ b/svdoc/src/lib/Sidebar.svelte @@ -0,0 +1,31 @@ + + + + + diff --git a/svdoc/src/lib/TableOfContents.svelte b/svdoc/src/lib/TableOfContents.svelte new file mode 100644 index 00000000..c4c3dcd6 --- /dev/null +++ b/svdoc/src/lib/TableOfContents.svelte @@ -0,0 +1,104 @@ + + +{#if headings.length > 0} + +{/if} + + diff --git a/svdoc/src/lib/Tags.svelte b/svdoc/src/lib/Tags.svelte new file mode 100644 index 00000000..7e788500 --- /dev/null +++ b/svdoc/src/lib/Tags.svelte @@ -0,0 +1,39 @@ + + +{#if tags.length > 0} + +{/if} + + diff --git a/svdoc/src/lib/ThemeToggle.svelte b/svdoc/src/lib/ThemeToggle.svelte new file mode 100644 index 00000000..07fa5e29 --- /dev/null +++ b/svdoc/src/lib/ThemeToggle.svelte @@ -0,0 +1,28 @@ + + +++ {/snippet} + ++ + {#if searchQuery.trim() && results.length === 0 && !isLoading} ++++ {:else if results.length > 0} + {#each results as result, i (result.id)} + {@const doc = getDocument(result.id)} + {#if doc} + + {/if} + {/each} + {:else if !searchQuery.trim()} +No results found for "{searchQuery}"
+++ {/if} +Type to search the documentation
++ ββ to navigate + Enter to select + Esc to close +++ {#if theme === "dark"} + + {:else} + + {/if} + diff --git a/svdoc/src/lib/assets/favicon.svg b/svdoc/src/lib/assets/favicon.svg new file mode 100644 index 00000000..cc5dc66a --- /dev/null +++ b/svdoc/src/lib/assets/favicon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/svdoc/src/lib/components/PageMeta.svelte b/svdoc/src/lib/components/PageMeta.svelte new file mode 100644 index 00000000..5469bb9c --- /dev/null +++ b/svdoc/src/lib/components/PageMeta.svelte @@ -0,0 +1,140 @@ + + +{#if createdAt || modifiedAt || sourceUrl} + +{/if} + + diff --git a/svdoc/src/lib/components/Variable.svelte b/svdoc/src/lib/components/Variable.svelte new file mode 100644 index 00000000..7cdd1d81 --- /dev/null +++ b/svdoc/src/lib/components/Variable.svelte @@ -0,0 +1,110 @@ + + +{#if !browser} + {value} +{:else} + { + if (!readonly) { + ctx.setValue(name, value); + } + edit = false; + }} + onkeydown={handleKeydown} + {id} + class:hidden={!edit} + style="width: {inputWidth}px" + /> +{/if} + + diff --git a/svdoc/src/lib/constants.ts b/svdoc/src/lib/constants.ts new file mode 100644 index 00000000..7b23083f --- /dev/null +++ b/svdoc/src/lib/constants.ts @@ -0,0 +1,9 @@ +/** + * Directories to ignore when traversing the docs folder. + * These directories don't contain markdown content. + */ +export const IGNORED_DIRECTORIES = new Set([ + "assets", + "css", + "material_theme_stylesheet_overrides", +]); diff --git a/svdoc/src/lib/content-store.ts b/svdoc/src/lib/content-store.ts new file mode 100644 index 00000000..cab57749 --- /dev/null +++ b/svdoc/src/lib/content-store.ts @@ -0,0 +1,871 @@ +/** + * ContentStore - Central singleton for managing all markdown content + * + * This module provides a centralized store for: + * - Parsing and caching markdown files (including full tokens and attributes) + * - Building navigation trees from the cached documents + * - Managing tags and metadata + * - File watching for development hot reload + * + * Files are processed once and cached. Navigation and page serving + * both use this cache, avoiding duplicate file reads. + */ + +import type { Token, TokensList } from "marked"; +import { readdir, stat } from "node:fs/promises"; +import { relative, resolve } from "node:path"; +import { IGNORED_DIRECTORIES } from "./constants"; +import { + extractHeadingsFromTokens, + extractSummaryFromTokens, + stripMarkdownTokens, + type Heading, +} from "./helpers/markdown-utils"; +import { readMarkdownFile, type Attributes } from "./markdown"; + +// Resolve the docs directory relative to project root +const DOCS_DIR = resolve(process.cwd(), "../docs"); + +// Environment variables for tenant-based filtering +// TENANT: the current tenant (e.g., "ssb", "nav") +// NOT_TENANT: exclusion tag with "not-" prefix (e.g., "not-ssb", "not-nav") +const TENANT = process.env.TENANT?.toLowerCase() || ""; +const NOT_TENANT = process.env.NOT_TENANT?.toLowerCase() || ""; + +// Log levels: "debug" | "info" | "warn" | "error" | "none" +const LOG_LEVEL = process.env.CONTENT_STORE_LOG_LEVEL?.toLowerCase() || "info"; + +const LOG_LEVELS = { debug: 0, info: 1, warn: 2, error: 3, none: 4 }; +const currentLogLevel = LOG_LEVELS[LOG_LEVEL as keyof typeof LOG_LEVELS] ?? LOG_LEVELS.info; + +const log = { + debug: (...args: unknown[]) => { + if (currentLogLevel <= LOG_LEVELS.debug) console.log("[content-store]", ...args); + }, + info: (...args: unknown[]) => { + if (currentLogLevel <= LOG_LEVELS.info) console.log("[content-store]", ...args); + }, + warn: (...args: unknown[]) => { + if (currentLogLevel <= LOG_LEVELS.warn) console.warn("[content-store]", ...args); + }, + error: (...args: unknown[]) => { + if (currentLogLevel <= LOG_LEVELS.error) console.error("[content-store]", ...args); + }, +}; + +log.debug(`Tenant filtering: TENANT="${TENANT}", NOT_TENANT="${NOT_TENANT}"`); + +/** + * Check if a file should be included based on its conditional frontmatter. + * + * The conditional frontmatter is an array of strings that controls visibility: + * + * 1. Exclude from specific tenants: + * conditional: [not-test-nais, not-nav] + * - Excluded when NOT_TENANT matches a value in conditional + * - NOT_TENANT already includes the "not-" prefix (e.g., NOT_TENANT=not-ssb) + * + * 2. Include only for specific tenants: + * conditional: [tenant, nav, ssb] + * - The keyword "tenant" indicates this is a tenant-specific page + * - Only included if TENANT matches one of the listed values (nav, ssb, etc.) + * + * @param conditional - The conditional array from frontmatter + * @param filePath - Optional file path for logging + * @returns true if the file should be included, false if it should be excluded + */ +export function shouldIncludeFile(conditional?: string[], filePath?: string): boolean { + if (!conditional || conditional.length === 0) { + return true; + } + + const normalizedConditional = conditional.map((c) => c.toLowerCase()); + + // Check for NOT_TENANT exclusion + // NOT_TENANT already has the "not-" prefix (e.g., "not-ssb") + // Exclude if the file's conditional array contains this value + if (NOT_TENANT && normalizedConditional.includes(NOT_TENANT)) { + log.debug(`Excluding "${filePath}" - matches NOT_TENANT="${NOT_TENANT}"`); + return false; + } + + // Check for tenant-specific inclusion + // If the file has "tenant" in conditional, it's a tenant-specific page + // Only include if TENANT is set and matches one of the other values + if (normalizedConditional.includes("tenant")) { + if (!TENANT) { + // No TENANT set, exclude tenant-specific pages + log.debug(`Excluding "${filePath}" - tenant-specific but no TENANT set`); + return false; + } + // Check if TENANT matches any of the values (excluding "tenant" keyword itself) + const allowedTenants = normalizedConditional.filter((c) => c !== "tenant"); + if (!allowedTenants.includes(TENANT)) { + log.debug( + `Excluding "${filePath}" - TENANT="${TENANT}" not in allowed list [${allowedTenants.join(", ")}]`, + ); + return false; + } + } + + return true; +} + +/** + * Represents a parsed markdown document with all its metadata and content + */ +export interface ContentDocument { + /** Absolute file path */ + filePath: string; + /** URL path (e.g., "/workloads/how-to/access") */ + urlPath: string; + /** Whether this is a README.md file */ + isReadme: boolean; + /** Document title (from frontmatter or first heading) */ + title: string; + /** Optional description from frontmatter */ + description?: string; + /** Tags from frontmatter */ + tags: string[]; + /** Items to hide (e.g., "toc", "navigation") */ + hide: string[]; + /** Extracted headings for search/TOC */ + headings: Heading[]; + /** Stripped content for search indexing */ + searchContent: string; + /** Summary extracted from first paragraphs */ + summary?: string; + /** Last modified time */ + mtime: number; + /** Full parsed tokens for rendering */ + tokens: Token[] | TokensList; + /** Full attributes from frontmatter */ + attributes: Attributes; +} + +/** + * Represents tag information with associated pages + */ +export interface TagInfo { + /** Original tag name */ + name: string; + /** URL-safe slug */ + slug: string; + /** Number of pages with this tag */ + count: number; +} + +/** + * Represents a page associated with a tag + */ +export interface TaggedPage { + title: string; + path: string; + description?: string; + summary?: string; +} + +/** + * Navigation item in the sidebar tree + */ +export interface NavItem { + title: string; + href: string; + children?: NavItem[]; + hasContent: boolean; +} + +/** + * .pages file structure + */ +interface PagesFile { + nav?: (string | Record| null = null; + + /** + * Initialize the store by scanning all markdown files + */ + async initialize(): Promise { + // Prevent multiple simultaneous initializations + if (this.initializing) { + return this.initializing; + } + + if (this.initialized) { + return; + } + + this.initializing = this.doInitialize(); + await this.initializing; + this.initializing = null; + } + + private async doInitialize(): Promise { + const startTime = Date.now(); + log.info("Initializing..."); + + // Clear existing data + this.documents.clear(); + this.documentsByUrlPath.clear(); + this.tags.clear(); + this.tagPages.clear(); + this.navigation = null; + this.allPaths = null; + + // Scan all markdown files + const files = await this.findMarkdownFiles(DOCS_DIR); + log.debug(`Found ${files.length} markdown files`); + + // Process each file + for (const filePath of files) { + await this.processFile(filePath); + } + + // Build derived data + this.buildTagsIndex(); + this.navigation = await this.buildNavigation(); + + this.initialized = true; + log.info(`Initialized in ${Date.now() - startTime}ms with ${this.documents.size} documents`); + } + + /** + * Invalidate a specific file (called when file changes) + */ + async invalidateFile(filePath: string): Promise { + const absolutePath = resolve(filePath); + + // Find and remove old document + const oldDoc = this.documents.get(absolutePath); + if (oldDoc) { + this.documentsByUrlPath.delete(oldDoc.urlPath); + } + this.documents.delete(absolutePath); + + // Re-process the file + try { + await this.processFile(absolutePath); + } catch { + // File might have been deleted + this.documents.delete(absolutePath); + } + + // Rebuild derived data + this.buildTagsIndex(); + this.navigation = await this.buildNavigation(); + this.allPaths = null; + } + + /** + * Invalidate all content (full rebuild) + */ + async invalidateAll(): Promise { + this.initialized = false; + await this.initialize(); + } + + /** + * Process a single markdown file and add it to the cache + */ + private async processFile(filePath: string): Promise { + try { + const fileStat = await stat(filePath); + const { tokens, attributes } = await readMarkdownFile(filePath); + + // Check if file should be included based on conditional frontmatter + if (!shouldIncludeFile(attributes.conditional, filePath)) { + return; + } + + const { urlPath, isReadme } = filePathToUrlPath(filePath); + const title = attributes.title || "Untitled"; + const headings = extractHeadingsFromTokens(tokens); + const searchContent = stripMarkdownTokens(tokens).slice(0, 10000); + const summary = extractSummaryFromTokens(tokens); + + const doc: ContentDocument = { + filePath, + urlPath, + isReadme, + title, + description: attributes.description, + tags: attributes.tags || [], + hide: attributes.hide || [], + headings, + searchContent, + summary, + mtime: fileStat.mtimeMs, + tokens, + attributes, + }; + + this.documents.set(filePath, doc); + this.documentsByUrlPath.set(urlPath, doc); + } catch { + // Skip files that can't be read + } + } + + /** + * Build the tags index from all documents + */ + private buildTagsIndex(): void { + this.tags.clear(); + this.tagPages.clear(); + + for (const doc of this.documents.values()) { + for (const tag of doc.tags) { + const slug = tagToSlug(tag); + + // Update tag count + const existing = this.tags.get(slug); + if (existing) { + existing.count++; + } else { + this.tags.set(slug, { name: tag, slug, count: 1 }); + } + + // Add page to tag + const pages = this.tagPages.get(slug) || []; + pages.push({ + title: doc.title, + path: withBase(doc.urlPath), + description: doc.description, + summary: doc.summary, + }); + this.tagPages.set(slug, pages); + } + } + + // Sort pages within each tag + for (const pages of this.tagPages.values()) { + pages.sort((a, b) => a.title.localeCompare(b.title)); + } + } + + /** + * Recursively find all markdown files + */ + private async findMarkdownFiles(dirPath: string): Promise { + await this.initialize(); + + // Normalize the path + const normalizedPath = urlPath.startsWith("/") ? urlPath : `/${urlPath}`; + return this.documentsByUrlPath.get(normalizedPath); + } + + /** + * Get a document by its file path + */ + async getDocumentByFilePath(filePath: string): Promise { + await this.initialize(); + return this.documents.get(resolve(filePath)); + } + + /** + * Get parsed markdown content for a URL path + * Returns the cached tokens and attributes directly from the store + */ + async getContent( + urlPath: string, + ): Promise<{ tokens: Token[] | TokensList; attributes: Attributes } | null> { + await this.initialize(); + + const doc = await this.getDocumentByPath(urlPath); + if (!doc) return null; + + return { + tokens: doc.tokens, + attributes: doc.attributes, + }; + } + + /** + * Get all tags with their counts + */ + async getAllTags(): Promise { + await this.initialize(); + return this.tags.get(slug); + } + + /** + * Get all pages for a tag + */ + async getTagPages(slug: string): Promise { + try { + const { parse: parseYaml } = await import("yaml"); + const pagesPath = `${dirPath}/.pages`; + const content = await Bun.file(pagesPath).text(); + return parseYaml(content) as PagesFile; + } catch { + return null; + } + } + + /** + * Get directory contents from filesystem + */ + private async getDirectoryContents(dirPath: string): Promise { + try { + const s = await stat(path); + return s.isDirectory(); + } catch { + return false; + } + } + + /** + * Build the navigation tree from cached documents + */ + private async buildNavigation(): Promise { + const fullPath = `${dirPath}/${path}`; + const isDir = await this.isDirectory(fullPath); + + // Check if this item should be included + if (!this.isItemIncluded(fullPath, isDir)) { + return null; + } + + // Check for hidden directory + if (isDir) { + const pagesFile = await this.readPagesFile(fullPath); + if (pagesFile?.hide === true) { + return null; + } + } + + let title = explicitTitle || filenameToTitle(path); + + if (isDir) { + const children = await this.buildNavForDirectory(fullPath); + const hasContent = this.hasIncludedReadme(fullPath); + + // If no children and no content, skip + if (children.length === 0 && !hasContent) { + return null; + } + + // Get title from README if available + if (!explicitTitle) { + const readmeTitle = this.getTitleForPath(`${fullPath}/README.md`); + if (readmeTitle) { + title = readmeTitle; + } + } + + // Build URL path for this directory + const urlPath = fullPath.slice(DOCS_DIR.length) || "/"; + + return { + title, + href: urlPathToHref(urlPath), + children: children.length > 0 ? children : undefined, + hasContent, + }; + } else { + const mdPath = path.endsWith(".md") ? fullPath : `${fullPath}.md`; + + if (!explicitTitle) { + const fileTitle = this.getTitleForPath(mdPath); + if (fileTitle) { + title = fileTitle; + } + } + + // Get URL path from document + const doc = this.documents.get(mdPath); + const urlPath = doc?.urlPath || filePathToUrlPath(mdPath).urlPath; + + return { + title, + href: urlPathToHref(urlPath), + hasContent: true, + }; + } + } + + /** + * Build navigation for a directory + */ + private async buildNavForDirectory(dirPath: string): Promise (); + + for (const entry of nav) { + if ( + entry === "..." || + entry === "" || + (typeof entry === "object" && Object.keys(entry)[0] === "") + ) { + continue; + } + const path = typeof entry === "string" ? entry : Object.values(entry)[0]; + explicitPaths.add(path); + explicitPaths.add(path.replace(/\.md$/, "")); + } + + for (const entry of nav) { + if (entry === "" || (typeof entry === "object" && Object.keys(entry)[0] === "")) { + continue; + } + + if (entry === "...") { + // Include all non-explicit items + const allContents = await this.getDirectoryContents(dirPath); + + for (const name of allContents) { + const nameWithoutExt = name.replace(/\.md$/, ""); + if (explicitPaths.has(name) || explicitPaths.has(nameWithoutExt)) continue; + if (name.toLowerCase() === "readme.md") continue; + + const item = await this.processNavItem(dirPath, name, null); + if (item) items.push(item); + } + continue; + } + + let title: string | null = null; + let path: string; + + if (typeof entry === "string") { + path = entry; + } else { + const key = Object.keys(entry)[0]; + title = key; + path = entry[key]; + } + + if ((path === "README.md" || path.toLowerCase() === "readme.md") && !title) { + continue; + } + + const item = await this.processNavItem(dirPath, path, title); + if (item) items.push(item); + } + + return items; + } +} + +// Use globalThis to ensure singleton is shared across all module contexts +// This is necessary because Vite plugin and SvelteKit server may have different module instances +const CONTENT_STORE_KEY = Symbol.for("nais-doc-content-store"); + +function getContentStore(): ContentStore { + const globalAny = globalThis as unknown as { [key: symbol]: ContentStore }; + if (!globalAny[CONTENT_STORE_KEY]) { + globalAny[CONTENT_STORE_KEY] = new ContentStore(); + } + return globalAny[CONTENT_STORE_KEY]; +} + +// Export singleton instance +export const contentStore = getContentStore(); diff --git a/svdoc/src/lib/helpers/git.ts b/svdoc/src/lib/helpers/git.ts new file mode 100644 index 00000000..e1a929f3 --- /dev/null +++ b/svdoc/src/lib/helpers/git.ts @@ -0,0 +1,78 @@ +import { execSync } from "child_process"; +import { resolve } from "path"; + +export interface GitInfo { + /** ISO date string of first commit for the file */ + createdAt?: string; + /** ISO date string of last commit for the file */ + modifiedAt?: string; + /** Relative path from repo root */ + sourcePath?: string; +} + +/** + * Get git information for a file + */ +export function getGitInfo(filePath: string): GitInfo { + // Resolve to absolute path + const absolutePath = resolve(filePath); + + let repoRoot: string; + try { + repoRoot = execSync("git rev-parse --show-toplevel", { + cwd: process.cwd(), + encoding: "utf-8", + stdio: ["pipe", "pipe", "pipe"], + }).trim(); + } catch { + return {}; + } + + // Get the path relative to the repo root + let sourcePath: string | undefined; + const resolvedRepoRoot = resolve(repoRoot); + if (absolutePath.startsWith(resolvedRepoRoot)) { + sourcePath = absolutePath.slice(resolvedRepoRoot.length + 1); + } + + let createdAt: string | undefined; + let modifiedAt: string | undefined; + + try { + // Get the date of the first commit (creation date) + // Use --follow to handle renames, get all commits and take the last one (oldest) + const createdResult = execSync(`git log --follow --format=%aI -- "${absolutePath}"`, { + cwd: repoRoot, + encoding: "utf-8", + stdio: ["pipe", "pipe", "pipe"], + }); + const dates = createdResult.trim().split("\n").filter(Boolean); + if (dates.length > 0) { + // Last entry is the oldest (first commit) + createdAt = dates[dates.length - 1]; + } + } catch { + // File might not be tracked by git + } + + try { + // Get the date of the last commit (modification date) + const modifiedResult = execSync(`git log -1 --format=%aI -- "${absolutePath}"`, { + cwd: repoRoot, + encoding: "utf-8", + stdio: ["pipe", "pipe", "pipe"], + }); + const modifiedDate = modifiedResult.trim(); + if (modifiedDate) { + modifiedAt = modifiedDate; + } + } catch { + // File might not be tracked by git + } + + return { + createdAt, + modifiedAt, + sourcePath, + }; +} diff --git a/svdoc/src/lib/helpers/icons.ts b/svdoc/src/lib/helpers/icons.ts new file mode 100644 index 00000000..fe769244 --- /dev/null +++ b/svdoc/src/lib/helpers/icons.ts @@ -0,0 +1,80 @@ +import { icons as octicon } from "@iconify-json/octicon"; +import { icons as mdi } from "@iconify-json/mdi"; +import { icons as simpleIcons } from "@iconify-json/simple-icons"; +import { icons as fa6Brands } from "@iconify-json/fa6-brands"; +import { getIconData, iconToSVG, iconToHTML } from "@iconify/utils"; +import type { IconifyJSON } from "@iconify/types"; + +// Known icon set prefixes mapped to their data +const iconSets: Record or | null = null; + +/** + * Get or create the Shiki highlighter instance + */ +export async function getHighlighter(): Promise { + if (!highlighterPromise) { + highlighterPromise = createHighlighter({ + themes: ["github-dark", "github-light", "github-dark-default", "github-light-default"], + langs: [ + "javascript", + "typescript", + "json", + "yaml", + "bash", + "shell", + "python", + "go", + "rust", + "java", + "kotlin", + "sql", + "html", + "css", + "markdown", + "dockerfile", + "toml", + "xml", + "http", + "groovy", + "diff", + "plaintext", + ], + }); + } + return highlighterPromise; +} + +/** + * Parse hl_lines attribute from code fence info string + * Supports formats like: hl_lines="4-5 8" or hl_lines="1 2 3" + * Returns a Set of 1-based line numbers to highlight + */ +export function parseHighlightLines(lang: string): { + language: string; + highlightLines: Set ; +} { + const highlightLines = new Set (); + + // Match hl_lines="..." pattern + const hlMatch = lang.match(/hl_lines=["']([^"']+)["']/); + if (!hlMatch) { + // Also clean any other attributes from lang + const cleanLang = lang.split(/\s+/)[0] || "text"; + return { language: cleanLang, highlightLines }; + } + + const hlValue = hlMatch[1]; + const parts = hlValue.split(/\s+/); + + for (const part of parts) { + if (part.includes("-")) { + // Range like "4-5" + const [start, end] = part.split("-").map(Number); + if (!isNaN(start) && !isNaN(end)) { + for (let i = start; i <= end; i++) { + highlightLines.add(i); + } + } + } else { + // Single line number + const lineNum = Number(part); + if (!isNaN(lineNum)) { + highlightLines.add(lineNum); + } + } + } + + // Extract clean language (first word before any attributes) + const cleanLang = lang.split(/\s+/)[0] || "text"; + + return { language: cleanLang, highlightLines }; +} + +/** + * Parse title attribute from code fence info string + * Supports format: title="filename.ts" + */ +export function parseTitle(lang: string): string | null { + const titleMatch = lang.match(/title=["']([^"']+)["']/); + return titleMatch ? titleMatch[1] : null; +} + +/** + * Code annotation found in source code + */ +export interface CodeAnnotation { + id: string; + line: number; + stripComment: boolean; +} + +// Common annotation patterns for different comment styles +// Pattern captures: (before comment)(comment start + text before annotation)(annotation id)(optional ! for strip)(rest) +const HASH_COMMENT = /^(.*?)(#[^(]*)\((\d+)\)(!)?(.*)$/; +const DOUBLE_SLASH = /^(.*?)(\/\/[^(]*)\((\d+)\)(!)?(.*)$/; +const BLOCK_COMMENT = /^(.*?)(\/\*[^(]*)\((\d+)\)(!)?[^*]*\*\/(.*)$/; +const HTML_COMMENT = /^(.*?)((.*)$/; +const SQL_COMMENT = /^(.*?)(--[^(]*)\((\d+)\)(!)?(.*)$/; + +// Language to comment pattern mapping +const LANGUAGE_PATTERNS: Record , + lineToAnnotation: Map { + const { language, highlightLines } = parseHighlightLines(langInfo); + const title = parseTitle(langInfo); + const normalizedLang = normalizeLanguage(language); + + // Parse code annotations + const { cleanedCode, annotations } = parseCodeAnnotations(code, language); + + // Extract variables and replace with placeholders + const { processedCode, variables } = extractVariables(cleanedCode); + + const highlighter = await getHighlighter(); + + // Load language dynamically if not already loaded + const loadedLangs = highlighter.getLoadedLanguages(); + if (!loadedLangs.includes(normalizedLang) && normalizedLang !== "plaintext") { + try { + await highlighter.loadLanguage(normalizedLang as BundledLanguage); + } catch { + // Fall back to plaintext if language can't be loaded + } + } + + const themeId = theme === "dark" ? "github-dark" : "github-light"; + + // Build a map of line numbers to annotation IDs + const lineToAnnotation = new Map (source); + + // Get git information for the file + const gitInfo = getGitInfo(path); + + // Process template variables (< ++{:else} ++ ++++ + +{/if} + + diff --git a/svdoc/src/lib/renderers/Blockquote.svelte b/svdoc/src/lib/renderers/Blockquote.svelte new file mode 100644 index 00000000..d17526a4 --- /dev/null +++ b/svdoc/src/lib/renderers/Blockquote.svelte @@ -0,0 +1,33 @@ + + ++ +{token.title} ++ ++ + {#if (token.tokens?.length || 0) > 0} +
+ + diff --git a/svdoc/src/lib/renderers/Br.svelte b/svdoc/src/lib/renderers/Br.svelte new file mode 100644 index 00000000..71434287 --- /dev/null +++ b/svdoc/src/lib/renderers/Br.svelte @@ -0,0 +1,8 @@ + + ++ {:else} + {token.text} + {/if} +
diff --git a/svdoc/src/lib/renderers/Checkbox.svelte b/svdoc/src/lib/renderers/Checkbox.svelte new file mode 100644 index 00000000..41cbe134 --- /dev/null +++ b/svdoc/src/lib/renderers/Checkbox.svelte @@ -0,0 +1,39 @@ + + + + {#if token.checked} + + {:else} + + {/if} + + + diff --git a/svdoc/src/lib/renderers/Code.svelte b/svdoc/src/lib/renderers/Code.svelte new file mode 100644 index 00000000..b4e4c05c --- /dev/null +++ b/svdoc/src/lib/renderers/Code.svelte @@ -0,0 +1,18 @@ + + +{#if isMermaid} ++{:else} + +{/if} diff --git a/svdoc/src/lib/renderers/Codespan.svelte b/svdoc/src/lib/renderers/Codespan.svelte new file mode 100644 index 00000000..bebb2b83 --- /dev/null +++ b/svdoc/src/lib/renderers/Codespan.svelte @@ -0,0 +1,93 @@ + + + + +{#if !hasVariables} + {token.text}+{:else} ++ {#each variables as segment, i (i)} + {#if segment.type === "text"} + {segment.content} + {:else if segment.type === "variable"} ++{/if} + + diff --git a/svdoc/src/lib/renderers/ContentRenderer.svelte b/svdoc/src/lib/renderers/ContentRenderer.svelte new file mode 100644 index 00000000..6438ced8 --- /dev/null +++ b/svdoc/src/lib/renderers/ContentRenderer.svelte @@ -0,0 +1,14 @@ + + ++ {/if} + {/each} + +diff --git a/svdoc/src/lib/renderers/ContentTabs.svelte b/svdoc/src/lib/renderers/ContentTabs.svelte new file mode 100644 index 00000000..fdd16f87 --- /dev/null +++ b/svdoc/src/lib/renderers/ContentTabs.svelte @@ -0,0 +1,125 @@ + + ++ ++ + diff --git a/svdoc/src/lib/renderers/Def.svelte b/svdoc/src/lib/renderers/Def.svelte new file mode 100644 index 00000000..b5c473d1 --- /dev/null +++ b/svdoc/src/lib/renderers/Def.svelte @@ -0,0 +1,5 @@ + diff --git a/svdoc/src/lib/renderers/DefinitionList.svelte b/svdoc/src/lib/renderers/DefinitionList.svelte new file mode 100644 index 00000000..8e976575 --- /dev/null +++ b/svdoc/src/lib/renderers/DefinitionList.svelte @@ -0,0 +1,75 @@ + + +++++ + {#each token.tabs as tab, i (i)} ++ {#each token.tabs as tab, i (i)} + + + {/each} ++++ {/each} ++++ -
+ {#each token.items as item, i (i)}
+
-
+
+
+ {#each item.definitions as definition, j (j)}
+ -
+
+
+ {/each}
+ {/each}
+
+ {#if (token.tokens?.length || 0) > 0} ++ + diff --git a/svdoc/src/lib/renderers/Em.svelte b/svdoc/src/lib/renderers/Em.svelte new file mode 100644 index 00000000..ab84ee83 --- /dev/null +++ b/svdoc/src/lib/renderers/Em.svelte @@ -0,0 +1,14 @@ + + + + {#if (token.tokens?.length || 0) > 0} ++ {:else} + {token.text} + {/if} + + {:else} + {token.text} + {/if} + diff --git a/svdoc/src/lib/renderers/Escape.svelte b/svdoc/src/lib/renderers/Escape.svelte new file mode 100644 index 00000000..7ac3d540 --- /dev/null +++ b/svdoc/src/lib/renderers/Escape.svelte @@ -0,0 +1,7 @@ + + +{token.text} diff --git a/svdoc/src/lib/renderers/Footnote.svelte b/svdoc/src/lib/renderers/Footnote.svelte new file mode 100644 index 00000000..df0caaac --- /dev/null +++ b/svdoc/src/lib/renderers/Footnote.svelte @@ -0,0 +1,42 @@ + + + - +
+ + diff --git a/svdoc/src/lib/renderers/FootnoteRef.svelte b/svdoc/src/lib/renderers/FootnoteRef.svelte new file mode 100644 index 00000000..69b8c318 --- /dev/null +++ b/svdoc/src/lib/renderers/FootnoteRef.svelte @@ -0,0 +1,37 @@ + + +{token.label} + + diff --git a/svdoc/src/lib/renderers/Footnotes.svelte b/svdoc/src/lib/renderers/Footnotes.svelte new file mode 100644 index 00000000..34b0742b --- /dev/null +++ b/svdoc/src/lib/renderers/Footnotes.svelte @@ -0,0 +1,48 @@ + + ++ + β© + + + + + diff --git a/svdoc/src/lib/renderers/HR.svelte b/svdoc/src/lib/renderers/HR.svelte new file mode 100644 index 00000000..6f7e040d --- /dev/null +++ b/svdoc/src/lib/renderers/HR.svelte @@ -0,0 +1,16 @@ + + +
+-
+ {#each token.items as item (item.id)}
+
+ {/each} +
+ + diff --git a/svdoc/src/lib/renderers/HTML.svelte b/svdoc/src/lib/renderers/HTML.svelte new file mode 100644 index 00000000..d51b6070 --- /dev/null +++ b/svdoc/src/lib/renderers/HTML.svelte @@ -0,0 +1,8 @@ + + + +{@html token.text} diff --git a/svdoc/src/lib/renderers/Heading.svelte b/svdoc/src/lib/renderers/Heading.svelte new file mode 100644 index 00000000..ef15fa0c --- /dev/null +++ b/svdoc/src/lib/renderers/Heading.svelte @@ -0,0 +1,65 @@ + + ++ + + diff --git a/svdoc/src/lib/renderers/HtmlWithMarkdown.svelte b/svdoc/src/lib/renderers/HtmlWithMarkdown.svelte new file mode 100644 index 00000000..d020e85a --- /dev/null +++ b/svdoc/src/lib/renderers/HtmlWithMarkdown.svelte @@ -0,0 +1,31 @@ + + ++ {#if headingId} + ΒΆ + {/if} + + + + diff --git a/svdoc/src/lib/renderers/Link.svelte b/svdoc/src/lib/renderers/Link.svelte new file mode 100644 index 00000000..26ee89c5 --- /dev/null +++ b/svdoc/src/lib/renderers/Link.svelte @@ -0,0 +1,14 @@ + + + + {#if (token.tokens?.length || 0) > 0} +
+ {:else} + {token.text} + {/if} + diff --git a/svdoc/src/lib/renderers/List.svelte b/svdoc/src/lib/renderers/List.svelte new file mode 100644 index 00000000..7e7f5f1c --- /dev/null +++ b/svdoc/src/lib/renderers/List.svelte @@ -0,0 +1,28 @@ + + + -
+ {#each token.items as item, i (i)}
+
+ {/each} + + {#if (token.tokens?.length || 0) > 0} + diff --git a/svdoc/src/lib/renderers/MermaidDiagram.svelte b/svdoc/src/lib/renderers/MermaidDiagram.svelte new file mode 100644 index 00000000..20e1ae96 --- /dev/null +++ b/svdoc/src/lib/renderers/MermaidDiagram.svelte @@ -0,0 +1,234 @@ + + ++ {:else} + {token.text} + {/if} + + {#if mermaidSvg} + + {@html mermaidSvg} + {:else if mermaidError} ++ + diff --git a/svdoc/src/lib/renderers/Paragraph.svelte b/svdoc/src/lib/renderers/Paragraph.svelte new file mode 100644 index 00000000..c45dce3f --- /dev/null +++ b/svdoc/src/lib/renderers/Paragraph.svelte @@ -0,0 +1,15 @@ + + +++ {:else} + +Failed to render diagram:
+{mermaidError}+++Show source
+{text}+++ {/if} ++ mermaid + ++
+{text}+ {#if (token.tokens?.length || 0) > 0} + diff --git a/svdoc/src/lib/renderers/Renderer.svelte b/svdoc/src/lib/renderers/Renderer.svelte new file mode 100644 index 00000000..c8471c8b --- /dev/null +++ b/svdoc/src/lib/renderers/Renderer.svelte @@ -0,0 +1,90 @@ + + +{#each tokens as token, i (i)} + {#if components[token.type]} + {@const Component = components[token.type]} ++ {:else} + {token.text} + {/if} + + {:else} + Unknown token type: {token.type}+ {/if} +{/each} + + diff --git a/svdoc/src/lib/renderers/ShikiCode.svelte b/svdoc/src/lib/renderers/ShikiCode.svelte new file mode 100644 index 00000000..0a17be98 --- /dev/null +++ b/svdoc/src/lib/renderers/ShikiCode.svelte @@ -0,0 +1,347 @@ + + +++ +{#if hasAnnotations} ++ {#if title} + {title} + {:else if language && language !== "text" && language !== "plaintext"} + {language} + {:else} + Plaintext + {/if} + +++ + {@html highlighted.html} +++ {#each annotationsWithContent as annotation (annotation.id)} ++{/if} + + diff --git a/svdoc/src/lib/renderers/Space.svelte b/svdoc/src/lib/renderers/Space.svelte new file mode 100644 index 00000000..6d4819ff --- /dev/null +++ b/svdoc/src/lib/renderers/Space.svelte @@ -0,0 +1,8 @@ + + + diff --git a/svdoc/src/lib/renderers/Strong.svelte b/svdoc/src/lib/renderers/Strong.svelte new file mode 100644 index 00000000..0956cd80 --- /dev/null +++ b/svdoc/src/lib/renderers/Strong.svelte @@ -0,0 +1,14 @@ + + + + {#if (token.tokens?.length || 0) > 0} ++ {annotation.id} ++ {/each} ++++ + {:else} + {token.text} + {/if} + diff --git a/svdoc/src/lib/renderers/Table.svelte b/svdoc/src/lib/renderers/Table.svelte new file mode 100644 index 00000000..6a11d9ec --- /dev/null +++ b/svdoc/src/lib/renderers/Table.svelte @@ -0,0 +1,39 @@ + + + ++ + diff --git a/svdoc/src/lib/renderers/Text.svelte b/svdoc/src/lib/renderers/Text.svelte new file mode 100644 index 00000000..aca4c27f --- /dev/null +++ b/svdoc/src/lib/renderers/Text.svelte @@ -0,0 +1,12 @@ + + +{#if (token.tokens?.length || 0) > 0} ++ +
++ {#each token.header as cell, i (i)} + + + + {#each token.rows as row, rowIndex (rowIndex)} ++ + {/each} ++ + {#each row as cell, cellIndex (cellIndex)} + + {/each} + ++ + {/each} ++ +{:else} + {token.text} +{/if} diff --git a/svdoc/src/lib/state/page_context.svelte.ts b/svdoc/src/lib/state/page_context.svelte.ts new file mode 100644 index 00000000..68932d0c --- /dev/null +++ b/svdoc/src/lib/state/page_context.svelte.ts @@ -0,0 +1,46 @@ +import { browser } from "$app/environment"; +import { createContext } from "svelte"; +import { SvelteMap } from "svelte/reactivity"; + +class PageContext { + variables: SvelteMap (); + +function setupContext() { + const context = new PageContext(); + setContext(context); + return context; +} + +export { getContext, PageContext, setupContext }; diff --git a/svdoc/src/lib/state/theme.svelte.ts b/svdoc/src/lib/state/theme.svelte.ts new file mode 100644 index 00000000..c23696ca --- /dev/null +++ b/svdoc/src/lib/state/theme.svelte.ts @@ -0,0 +1,30 @@ +import { createContext } from "svelte"; + +export type Theme = "light" | "dark"; + +class ThemeState { + #theme: Theme = $state("dark"); + + get theme(): Theme { + return this.#theme; + } + + set theme(value: Theme) { + this.#theme = value; + } + + get isDark(): boolean { + return this.#theme === "dark"; + } +} + +const [getTheme, setTheme] = createContext (); + +function setupTheme(initialTheme: Theme = "dark"): ThemeState { + const state = new ThemeState(); + state.theme = initialTheme; + setTheme(state); + return state; +} + +export { getTheme, setupTheme, ThemeState }; diff --git a/svdoc/src/lib/types/tokens.ts b/svdoc/src/lib/types/tokens.ts new file mode 100644 index 00000000..de9f6b5c --- /dev/null +++ b/svdoc/src/lib/types/tokens.ts @@ -0,0 +1,127 @@ +import type { Token } from "marked"; + +/** + * Admonition token for Material for MkDocs style admonitions + * Syntax: !!! type "title" or ??? type "title" (collapsible) or ???+ type "title" (collapsible, open) + */ +export interface AdmonitionToken { + type: "admonition"; + raw: string; + admonitionType: string; + title: string; + collapsible: boolean; + open: boolean; + tokens: Token[]; +} + +/** + * Content tab token for Material for MkDocs style tabs + * Syntax: === "Tab Title" + */ +export interface ContentTabToken { + type: "content_tab"; + raw: string; + label: string; + tokens: Token[]; +} + +/** + * Container for multiple content tabs + */ +export interface ContentTabsToken { + type: "content_tabs"; + raw: string; + tabs: ContentTabToken[]; +} + +/** + * Footnote reference token (inline [^1]) + */ +export interface FootnoteRefToken { + type: "footnoteRef"; + raw: string; + id: string; + label: string; +} + +/** + * Footnote definition token ([^1]: content) + */ +export interface FootnoteToken { + type: "footnote"; + raw: string; + id: string; + label: string; + tokens: Token[]; +} + +/** + * Container for all footnotes at the end of a document + */ +export interface FootnotesToken { + type: "footnotes"; + raw: string; + items: FootnoteToken[]; +} + +/** + * HTML block with markdown attribute parsed + */ +export interface HtmlWithMarkdownToken { + type: "html_with_markdown"; + raw: string; + text: string; + openTag: string; + closeTag: string; + innerTokens: Token[]; +} + +/** + * Definition list item (term + definitions) + */ +export interface DefinitionListItemToken { + type: "def_list_item"; + raw: string; + term: string; + termTokens: Token[]; + definitions: DefinitionToken[]; +} + +/** + * Single definition in a definition list + */ +export interface DefinitionToken { + type: "definition"; + raw: string; + tokens: Token[]; +} + +/** + * Definition list container + */ +export interface DefinitionListToken { + type: "def_list"; + raw: string; + items: DefinitionListItemToken[]; +} + +/** + * Frontmatter attributes extracted from markdown files + */ +export interface Attributes { + title?: string; + description?: string; + tags?: string[]; + hide?: string[]; + /** Conditional visibility based on tenant */ + conditional?: string[]; + /** Git metadata */ + git?: { + /** Date the file was first created (first commit) */ + createdAt?: string; + /** Date the file was last modified (last commit) */ + modifiedAt?: string; + /** Relative path to the source file in the repo */ + sourcePath?: string; + }; +} diff --git a/svdoc/src/lib/utils.ts b/svdoc/src/lib/utils.ts new file mode 100644 index 00000000..c0cb7ae5 --- /dev/null +++ b/svdoc/src/lib/utils.ts @@ -0,0 +1,13 @@ +/** + * Shared utilities that are safe to use on both client and server + */ + +/** + * Convert a tag name to a URL-safe slug + */ +export function tagToSlug(tag: string): string { + return tag + .toLowerCase() + .replace(/\s+/g, "-") + .replace(/[^a-z0-9-]/g, ""); +} diff --git a/svdoc/src/lib/vite-plugin-content-watcher.ts b/svdoc/src/lib/vite-plugin-content-watcher.ts new file mode 100644 index 00000000..22d99730 --- /dev/null +++ b/svdoc/src/lib/vite-plugin-content-watcher.ts @@ -0,0 +1,85 @@ +/** + * Vite plugin for watching markdown files and triggering HMR + * + * This plugin watches the docs directory for changes to markdown files + * and .pages files, then triggers a full page reload when changes are detected. + */ + +import type { Plugin, ViteDevServer } from "vite"; +import { resolve } from "node:path"; + +const DOCS_DIR = resolve(process.cwd(), "../docs"); + +export function contentWatcherPlugin(): Plugin { + let server: ViteDevServer | null = null; + + return { + name: "content-watcher", + + configureServer(viteServer) { + server = viteServer; + + // Watch the docs directory for changes + const watcher = server.watcher; + + // Add the docs directory to the watcher + watcher.add(DOCS_DIR); + + // Handle file changes + const handleChange = async (filePath: string) => { + // Only handle markdown and .pages files + if (!filePath.endsWith(".md") && !filePath.endsWith(".pages")) { + return; + } + + // Only handle files in the docs directory + if (!filePath.startsWith(DOCS_DIR)) { + return; + } + + console.log(`[content-watcher] File changed: ${filePath}`); + + // Invalidate the content store + try { + const { contentStore } = await import("./content-store"); + await contentStore.invalidateFile(filePath); + } catch (error) { + console.error("[content-watcher] Failed to invalidate content store:", error); + } + + // Send full reload signal to the browser + server?.ws.send({ + type: "full-reload", + path: "*", + }); + }; + + watcher.on("change", handleChange); + watcher.on("add", handleChange); + watcher.on("unlink", async (filePath) => { + if (!filePath.endsWith(".md") && !filePath.endsWith(".pages")) { + return; + } + + if (!filePath.startsWith(DOCS_DIR)) { + return; + } + + console.log(`[content-watcher] File deleted: ${filePath}`); + + // Invalidate the entire store on deletion + try { + const { contentStore } = await import("./content-store"); + await contentStore.invalidateAll(); + } catch (error) { + console.error("[content-watcher] Failed to invalidate content store:", error); + } + + server?.ws.send({ + type: "full-reload", + path: "*", + }); + }); + }, + }; +} diff --git a/svdoc/src/routes/+error.svelte b/svdoc/src/routes/+error.svelte new file mode 100644 index 00000000..dc10ae05 --- /dev/null +++ b/svdoc/src/routes/+error.svelte @@ -0,0 +1,101 @@ + + + ++ + diff --git a/svdoc/src/routes/+layout.server.ts b/svdoc/src/routes/+layout.server.ts new file mode 100644 index 00000000..af2ab442 --- /dev/null +++ b/svdoc/src/routes/+layout.server.ts @@ -0,0 +1,6 @@ +import { contentStore } from "$lib/content-store"; + +export const load = async () => { + const navigation = await contentStore.getNavigation(); + return { navigation }; +}; diff --git a/svdoc/src/routes/+layout.svelte b/svdoc/src/routes/+layout.svelte new file mode 100644 index 00000000..8c5fbda6 --- /dev/null +++ b/svdoc/src/routes/+layout.svelte @@ -0,0 +1,262 @@ + + ++ {page.status} + +++ {#if page.status === 404} + Page not found + {:else} + Something went wrong + {/if} + + ++ {#if page.status === 404} + The page you're looking for doesn't exist or has been moved. + {:else if page.error?.message} + {page.error.message} + {:else} + An unexpected error occurred. + {/if} + + ++ + + ++ +++Suggestions +-
+
- Check that the URL is spelled correctly +
- Use the search to find what you're looking for +
- Browse the navigation menu on the left +
+ + + diff --git a/svdoc/src/routes/+layout.ts b/svdoc/src/routes/+layout.ts new file mode 100644 index 00000000..189f71e2 --- /dev/null +++ b/svdoc/src/routes/+layout.ts @@ -0,0 +1 @@ +export const prerender = true; diff --git a/svdoc/src/routes/[...path]/+page.server.ts b/svdoc/src/routes/[...path]/+page.server.ts new file mode 100644 index 00000000..487530c2 --- /dev/null +++ b/svdoc/src/routes/[...path]/+page.server.ts @@ -0,0 +1,69 @@ +import { contentStore } from "$lib/content-store"; +import { getAllRedirects, getRedirectTarget } from "$lib/redirects"; +import type { Attributes } from "$lib/types/tokens"; +import { error, redirect } from "@sveltejs/kit"; +import type { EntryGenerator, PageServerLoad } from "./$types"; + +/** + * Generate all entry points for static prerendering + */ +export const entries: EntryGenerator = async () => { + const paths = await contentStore.getAllPaths(); + const redirects = await getAllRedirects(); + + // Combine regular paths and redirect source paths + const allPaths = [ + ...paths.map((path) => ({ path })), + ...redirects.map((r) => ({ path: r.from.replace(/^\//, "") })), + ]; + + return allPaths; +}; + +export const prerender = true; + +export const load: PageServerLoad = async ({ params }) => { + const { path } = params; + + // Normalize the URL path + const urlPath = !path || path === "" ? "/" : `/${path}`; + + // Try to get content from the content store + const content = await contentStore.getContent(urlPath); + + if (content) { + return { + tokens: content.tokens, + attributes: content.attributes, + }; + } + + // Check if it's a directory without README (category page) + // This happens when a directory has children but no README.md + const doc = await contentStore.getDocumentByPath(urlPath); + if (!doc) { + // Check if there are any documents under this path (category without content) + const allDocs = await contentStore.getAllDocuments(); + const hasChildren = allDocs.some((d) => d.urlPath.startsWith(urlPath + "/")); + + if (hasChildren) { + // Return empty tokens - this is a category page without content + return { + tokens: [], + attributes: {} as Attributes, + isCategory: true, + }; + } + } + + // Check if there's a redirect for this path + const redirectTarget = getRedirectTarget(path || ""); + if (redirectTarget) { + redirect(307, redirectTarget); + } + + // Nothing found - throw 404 + error(404, { + message: "Page not found", + }); +}; diff --git a/svdoc/src/routes/[...path]/+page.svelte b/svdoc/src/routes/[...path]/+page.svelte new file mode 100644 index 00000000..90eee2e7 --- /dev/null +++ b/svdoc/src/routes/[...path]/+page.svelte @@ -0,0 +1,85 @@ + + ++ + + +++ + ++ + + +Nais Docs ++ + + + + + + + +++ +{pageTitle} + + + + + + + + + + + + + + ++ {#if tags.length > 0} + + +{#if showToc} + +{/if} + + diff --git a/svdoc/src/routes/data/search-index.json/+server.ts b/svdoc/src/routes/data/search-index.json/+server.ts new file mode 100644 index 00000000..ca17b5c3 --- /dev/null +++ b/svdoc/src/routes/data/search-index.json/+server.ts @@ -0,0 +1,16 @@ +import { json } from "@sveltejs/kit"; +import type { RequestHandler } from "./$types"; +import { contentStore } from "$lib/content-store"; + +export const GET: RequestHandler = async () => { + const documents = await contentStore.getSearchIndex(); + + return json(documents, { + headers: { + "Cache-Control": "public, max-age=3600", + }, + }); +}; + +// Prerender this endpoint during build +export const prerender = true; diff --git a/svdoc/src/routes/tags/+page.server.ts b/svdoc/src/routes/tags/+page.server.ts new file mode 100644 index 00000000..f8a191e9 --- /dev/null +++ b/svdoc/src/routes/tags/+page.server.ts @@ -0,0 +1,12 @@ +import { contentStore } from "$lib/content-store"; +import type { PageServerLoad } from "./$types"; + +export const prerender = true; + +export const load: PageServerLoad = async () => { + const tags = await contentStore.getAllTags(); + + return { + tags, + }; +}; diff --git a/svdoc/src/routes/tags/+page.svelte b/svdoc/src/routes/tags/+page.svelte new file mode 100644 index 00000000..1da90a38 --- /dev/null +++ b/svdoc/src/routes/tags/+page.svelte @@ -0,0 +1,99 @@ + + ++ {/if} + + {#if showMeta && git} + + {/if} + Tags - Nais ++ + + diff --git a/svdoc/src/routes/tags/[tag]/+page.server.ts b/svdoc/src/routes/tags/[tag]/+page.server.ts new file mode 100644 index 00000000..3c7d2de1 --- /dev/null +++ b/svdoc/src/routes/tags/[tag]/+page.server.ts @@ -0,0 +1,30 @@ +import { contentStore } from "$lib/content-store"; +import { error } from "@sveltejs/kit"; +import type { PageServerLoad, EntryGenerator } from "./$types"; + +export const entries: EntryGenerator = async () => { + const tags = await contentStore.getAllTags(); + return tags.map((tag) => ({ tag: tag.slug })); +}; + +export const prerender = true; + +export const load: PageServerLoad = async ({ params }) => { + const { tag } = params; + + const tagInfo = await contentStore.getTag(tag); + + if (!tagInfo) { + error(404, { + message: `Tag "${tag}" not found`, + }); + } + + const pages = await contentStore.getTagPages(tag); + + return { + tag: tagInfo.name, + slug: tag, + pages, + }; +}; diff --git a/svdoc/src/routes/tags/[tag]/+page.svelte b/svdoc/src/routes/tags/[tag]/+page.svelte new file mode 100644 index 00000000..302ac27e --- /dev/null +++ b/svdoc/src/routes/tags/[tag]/+page.svelte @@ -0,0 +1,164 @@ + + +Tags
+Browse documentation by topic tags.
+ + + + {#if tags.length === 0} +No tags found.
+ {/if} +{tag} - Tags - Nais + ++ + + diff --git a/svdoc/static/assets b/svdoc/static/assets new file mode 120000 index 00000000..e593cfc6 --- /dev/null +++ b/svdoc/static/assets @@ -0,0 +1 @@ +../../docs/assets \ No newline at end of file diff --git a/svdoc/static/robots.txt b/svdoc/static/robots.txt new file mode 100644 index 00000000..b6dd6670 --- /dev/null +++ b/svdoc/static/robots.txt @@ -0,0 +1,3 @@ +# allow crawling everything by default +User-agent: * +Disallow: diff --git a/svdoc/svelte.config.js b/svdoc/svelte.config.js new file mode 100644 index 00000000..fc04a686 --- /dev/null +++ b/svdoc/svelte.config.js @@ -0,0 +1,46 @@ +import adapter from "@sveltejs/adapter-static"; +import { vitePreprocess } from "@sveltejs/vite-plugin-svelte"; + +/** @type {import('@sveltejs/kit').Config} */ +const config = { + // Consult https://svelte.dev/docs/kit/integrations + // for more information about preprocessors + preprocess: vitePreprocess(), + + compilerOptions: { + experimental: { + async: true, + }, + }, + + kit: { + // adapter-auto only supports some environments, see https://svelte.dev/docs/kit/adapter-auto for a list. + // If your environment is not supported, or you settled on a specific environment, switch out the adapter. + // See https://svelte.dev/docs/kit/adapters for more information about adapters. + adapter: adapter({ + fallback: "404.html", + }), + paths: { + base: process.env.BASE_PATH ?? "", + }, + prerender: { + handleHttpError: ({ path, referrer, message }) => { + // Ignore 404s for .md links - these are documentation links that + // should be handled at runtime (the Link component strips .md) + if (path.endsWith(".md")) { + console.warn(`Ignoring broken .md link: ${path} (from ${referrer})`); + return; + } + + // Throw for other errors + throw new Error(message); + }, + handleMissingId: ({ path, id, referrers }) => { + // Warn about missing IDs but don't fail the build + console.warn(`Missing id="${id}" on ${path} (linked from ${referrers.join(", ")})`); + }, + }, + }, +}; + +export default config; diff --git a/svdoc/tsconfig.json b/svdoc/tsconfig.json new file mode 100644 index 00000000..2c2ed3c4 --- /dev/null +++ b/svdoc/tsconfig.json @@ -0,0 +1,20 @@ +{ + "extends": "./.svelte-kit/tsconfig.json", + "compilerOptions": { + "rewriteRelativeImportExtensions": true, + "allowJs": true, + "checkJs": true, + "esModuleInterop": true, + "forceConsistentCasingInFileNames": true, + "resolveJsonModule": true, + "skipLibCheck": true, + "sourceMap": true, + "strict": true, + "moduleResolution": "bundler" + } + // Path aliases are handled by https://svelte.dev/docs/kit/configuration#alias + // except $lib which is handled by https://svelte.dev/docs/kit/configuration#files + // + // To make changes to top-level options such as include and exclude, we recommend extending + // the generated config; see https://svelte.dev/docs/kit/configuration#typescript +} diff --git a/svdoc/vite.config.ts b/svdoc/vite.config.ts new file mode 100644 index 00000000..8faba95a --- /dev/null +++ b/svdoc/vite.config.ts @@ -0,0 +1,8 @@ +import tailwindcss from "@tailwindcss/vite"; +import { sveltekit } from "@sveltejs/kit/vite"; +import { defineConfig } from "vite"; +import { contentWatcherPlugin } from "./src/lib/vite-plugin-content-watcher"; + +export default defineConfig({ + plugins: [tailwindcss(), sveltekit(), contentWatcherPlugin()], +});+ + + All tags + + + + {#if pages.length > 0} ++++
+ {pages.length} {pages.length === 1 ? "page" : "pages"} +{tag} +-
+ {#each pages as page (page.path)}
+
-
+
+
{page.title}
+ {#if page.description || page.summary} +{page.description || page.summary}
+ {/if} + +
+ {/each}
+
++ {/if} +No pages found with this tag.
+ Browse all tags + -
+
- `/`