DocsSiteConfig

Describes a documentation site. Every path is relative to DocsSiteConfig.rootDirectory.

Import:

import type { DocsSiteConfig } from '@mnaoumov/typescript-dev-toolkit/docs-site/docs-site-config';

Signature:

export interface DocsSiteConfig

Properties

Property	Type	Description
docsDirectory?	string	The folder holding the site: its `src` (pages, `content.config.ts`), `public` and build output `dist`.
externalTypeLinks?	ReadonlyMap<string, string>	Type names mapped to the URL their references link to, for types no documented package declares. The layer documenting an ecosystem's packages fills it with that ecosystem's references.
guidesDirectory?	string	The folder under `<docs>/src/content/docs` the guides sidebar group is generated from.
owner?	string	The GitHub account the repository belongs to.
packageSites?	ReadonlyMap<string, string>	Package names mapped to the root URL of their documentation site, with a trailing slash. A type declared in one of them links to its page there. The documented package itself is never linked this way.
repo	string	The repository's name. The site is served under it: `<siteOrigin>/<repo>/`.
repoHomepage?	RepoHomepageMode	What `buildDocsSite` does, after the build, about the repository's GitHub homepage: compare it with the site's URL and report a mismatch (`check`), or also set it (`set`). It reads and writes through the `gh` CLI, and only ever warns. A workflow's `GITHUB_TOKEN` can read the homepage but not set it, so in CI `set` reports too.
rootDirectory?	string	The repository root, holding `package.json`, `tsconfig.json` and `node_modules`.
siteOrigin?	string	The origin every site of the account is served from.
sourceDirectory?	string	The folder whose modules the API reference documents.
title	string	The site's title, shown in its header.

Links to this page: