ResolvedDocsSiteConfig

DocsSiteConfig with every default applied, every path absolute, and the values derived from them.

Import:

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

Signature:

export interface ResolvedDocsSiteConfig

Properties

Property	Type	Description
apiDocSettings	ApiDocSettings	The API documentation generator's settings for the site.
basePath	string	The base path, e.g. /typescript-lib.
contentDocsDirectory	string	The documentation content root, <docs>/src/content/docs.
distDirectory	string	The build output folder, <docs>/dist.
docsDirectory	string	The site folder.
docsSourceDirectory	string	The site's source folder, <docs>/src.
editLinkBaseUrl	string	The URL a page's edit link starts with: the repository's edit/main/ tree.
faviconPath	string	The site's SVG logo, <docs>/public/favicon.svg.
githubUrl	string	The repository's GitHub URL.
guidesDirectory	string	See DocsSiteConfig.guidesDirectory.
ogOutputDirectory	string	The folder the Open Graph cards are written to, <docs>/public/og.
owner	string	See DocsSiteConfig.owner.
packageName	string	The documented package's name, read from the root package.json.
packageVersion	string	The documented package's version, read from the root package.json.
publicDirectory	string	The site's static folder, <docs>/public.
repo	string	See DocsSiteConfig.repo.
repoHomepage	RepoHomepageMode	See DocsSiteConfig.repoHomepage.
rootDirectory	string	See DocsSiteConfig.rootDirectory.
siteBaseUrl	string	The absolute URL the site is served from, with a trailing slash.
siteOrigin	string	See DocsSiteConfig.siteOrigin.
sourceDirectory	string	See DocsSiteConfig.sourceDirectory.
title	string	See DocsSiteConfig.title.

---

Links to this page:

• resolveDocsSiteConfig