diff --git a/src/generators/web/README.md b/src/generators/web/README.md index 4b4fe774..1030755a 100644 --- a/src/generators/web/README.md +++ b/src/generators/web/README.md @@ -53,17 +53,17 @@ import { project, repository, editURL } from '#theme/config'; All scalar (non-object) configuration values are automatically exported. The defaults include: -| Export | Type | Description | -| ------------------------ | ------------------------------ | --------------------------------------------------------------------------------------------------- | -| `project` | `string` | Project name (e.g. `'Node.js'`) | -| `repository` | `string` | GitHub repository in `owner/repo` format | -| `version` | `string` | Current version label (e.g. `'v22.x'`) | -| `versions` | `Array<{ url, label, major }>` | Pre-computed version entries with labels and URL templates (only `{path}` remains for per-page use) | -| `editURL` | `string` | Partially populated "edit this page" URL template (only `{path}` remains) | -| `pages` | `Array<[string, string]>` | Sorted `[name, path]` tuples for sidebar navigation | -| `useAbsoluteURLs` | `boolean` | Whether internal links use absolute URLs (mirrors config value) | -| `baseURL` | `string` | Base URL for the documentation site (used when `useAbsoluteURLs` is `true`) | -| `languageDisplayNameMap` | `Map` | Shiki language alias → display name map for code blocks | +| Export | Type | Description | +| ------------------------ | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `project` | `string` | Project name (e.g. `'Node.js'`) | +| `repository` | `string` | GitHub repository in `owner/repo` format | +| `version` | `string` | Current version label (e.g. `'v22.x'`) | +| `versions` | `Array<{ url, label, major }>` | Pre-computed version entries with labels and URL templates (only `{path}` remains for per-page use) | +| `editURL` | `string` | Partially populated "edit this page" URL template (only `{path}` remains) | +| `pages` | `Array<[number, { heading, path, category? }]>` | Sorted `[weight, page]` tuples for sidebar navigation (explicit weights first, then default ordering) | +| `useAbsoluteURLs` | `boolean` | Whether internal links use absolute URLs (mirrors config value) | +| `baseURL` | `string` | Base URL for the documentation site (used when `useAbsoluteURLs` is `true`) | +| `languageDisplayNameMap` | `Map` | Shiki language alias → display name map for code blocks | #### Usage in custom components @@ -77,9 +77,9 @@ export default ({ metadata }) => (