Configuration

Here is full configuration reference for app.config.ts.

Main configuration

This data affects most visible parts of your documentation site.

Key	Type	Default	Description
`title`	`string`	d0xigen	Title of your documentation site. Most likely it is name of described project.
`social.github`	`string`	`undefined`	Link to GitHub repository of your project.

Meta information

This data affects meta tags of your documentation site.

Key	Type	Default	Description
`title`	`string`	d0xigen	Title of your documentation site. Most likely it is name of described project.
`description`	`string`	My awesome docs	Description of your documentation site.
`url`	`string`	https://d0rich.me	URL where your documentation site will be hosted.
`author`	`string`	Nikolai Dorofeev	Author of your documentation site. Most likely it is you.
`seo.keywords`	`string[]`	`[]`	Keywords for SEO. Affects only meta tags.
`og.image`	`string`	`/og/image.jpg`	Path to image for Open Graph protocol.

Additional features

You might like it.

Key	Type	Default	Description
`features.mermaid`	`boolean`	`true`	Toggle mermaidjs diagrams on website.
`features.gtag.id`	`string`	`G-XXXXXXXXXX`	Measurement id for Google Analytics.

Full reference

All config options in one place.

Key	Type	Default	Description
`title`	`string`	d0xigen	Title of your documentation site. Most likely it is name of described project.
`description`	`string`	My awesome docs	Description of your documentation site.
`url`	`string`	https://d0rich.me	URL where your documentation site will be hosted.
`author`	`string`	Nikolai Dorofeev	Author of your documentation site. Most likely it is you.
`social.github`	`string`	`undefined`	Link to GitHub repository of your project.
`seo.keywords`	`string[]`	`[]`	Keywords for SEO. Affects only meta tags.
`og.image`	`string`	`/og/image.jpg`	Path to image for Open Graph protocol.
`features.mermaid`	`boolean`	`true`	Toggle mermaidjs diagrams on website.
`features.gtag.id`	`string`	`G-XXXXXXXXXX`	Measurement id for Google Analytics.