Configuration
Example
# <!-- TODO: automd file generator should support code block wrapper! PR welcome ;) -->
<!-- automd:file src="../../template/.config/docs.yaml" -->
# yaml-language-server: $schema=https://unpkg.com/undocs/schema/config.json
name: 'packageName'
shortDescription: ''
description: ''
github: 'unjs/packageName'
# url: 'https://packageName.unjs.io'
# redirects:
# "/from": "/to"
# automd: true
landing:
heroLinks:
stackblitz:
icon: 'i-heroicons-play'
to: 'https://stackblitz.com/github/unjs/packageName/tree/main/playground'
# contributors: true
# features:
# - title:
# description:
<!-- /automd -->
Reference
$schema
string
automd
boolean
Enable integration with https://automd.unjs.io
buildCache
boolean
Enable build cache (experimental)
description
string
The description of the documentation site.
dir
string
Documentation directory
Note: This option will be automatically set
github
string
The GitHub repository for the documentation site.
landing
undefined
name
string
The name of the documentation site.
redirects
Redirects for the documentation site.
shortDescription
string
The description of the documentation site.
themeColor
string
The theme color of the documentation site.
It will be used as the theme-color meta tag and a full palette of colors will be generated from it.
url
string
The URL of the documentation site.
🤖 auto updated with automd