Global settings

Field-by-field reference for every option in publier.config.yaml.

The publier.config.yaml file at your project root controls site-wide settings — name, navigation, search, analytics, fonts, and snippets.

Full example

name: My Docs
url: https://docs.example.com

nav:
  links:
    - label: GitHub
      href: https://github.com/my-org/my-docs
      external: true

sidebar:
  defaultOpenLevel: 2

search:
  enabled: true

llms:
  enabled: true
  collections: [docs]

snippets:
  directory: src/content/snippets

Site

Field	Type	Required	Description
`name`	string	Yes	Site name — header, browser tab, meta tags
`url`	string	—	Production URL for sitemap, OG images, canonical links

Field	Type	Default	Description
`nav.links[].label`	string	—	Link text
`nav.links[].href`	string	—	URL (internal path or external)
`nav.links[].external`	boolean	`false`	Open in a new tab with `rel="noopener"`

GitHub links auto-render as icon buttons. Other external links render as text. See Navigation for variants and pathRules.

Field	Type	Default	Description
`sidebar.defaultOpenLevel`	number	`1`	Sidebar levels expanded by default

Search

Field	Type	Default	Description
`search.enabled`	boolean	`true`	Show the ⌘K dialog
`search.hotkey`	string	`"k"`	`Cmd/Ctrl + <hotkey>` opens the dialog

LLMs

Field	Type	Default	Description
`llms.enabled`	boolean	`false`	Generate `/llms.txt` and `/llms-full.txt` at build time
`llms.full`	boolean	`false`	Also emit `/llms-full.txt` with full Markdown bodies
`llms.collections`	string[]	`[]`	Collections to include (e.g. `['docs']`)

AI coding tools (Cursor, Copilot, Claude) read these files for documentation-aware suggestions.

Snippets

Field	Type	Default	Description
`snippets.directory`	string	`'content/snippets'`	Directory of reusable MDX fragments

See the Snippets guide for usage.

Logo and favicon

logo:
  light: /logo-light.svg   # shown in light mode
  dark: /logo-dark.svg     # shown in dark mode
favicon: /favicon.ico

Paths are relative to public/.

Edit link

Add an “Edit this page” link to every doc page:

editLink:
  baseUrl: https://github.com/my-org/my-docs/edit/main/src/content/docs

The current page path is appended automatically.

Pages

Toggle individual page types on or off:

pages:
  docs: true
  blog: true
  landing: false
  about: false
  team: false
  careers: false
  press: false
  contact: false
  changelog: true
  status: false
  knowledge-base: false

Setting a key to false suppresses the route entirely — it disappears from the sidebar, sitemap, search index, and RSS feed. See Pages for what each page does.