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

• Type: string

automd

• Type: boolean

Enable integration with https://automd.unjs.io

branch

• Type: string

The branch of the GitHub repository for the documentation site.

buildCache

• Type: boolean

Enable build cache (experimental)

description

• Type: string

The description of the documentation site.

dir

• Type: string

Documentation directory

Note: This option will be automatically set

github

• Type: string

The GitHub repository for the documentation site.

landing

• Type: undefined

name

• Type: string

The name of the documentation site.

redirects

Redirects for the documentation site.

shortDescription

• Type: string

The description of the documentation site.

themeColor

• Type: 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

• Type: string

The URL of the documentation site.