Configuration

Pyro has a very simplistic view of configurations, there is only one file you need to worry about (being pyro.yml/pyro.toml/pyro.json/pyro.jsonc).

What goes into a Pyro configuration file?

This is just a standard configuration file. Inside you will define all properties related to pyro and plugins you may install.

This is an example of a pyro.yml configuration file:

# The title of the site
title: Pyro

# The base URL to use for open graph absolute URLs (optional)
base: https://pyro.deno.dev

# The Github repository for the documentation site (optional)
github: https://github.com/lino-levan/pyro

# Any copyright information you want to include in the footer (optional)
copyright: |-
  Copyright © 2023 Lino Le Van
  MIT Licensed

# Links in the header (optional)
header:
  # links on the left side
  left:
    - Docs /getting-started/installation

  # links on the right side
  right:
    - Bonus Content https://stackoverflow.com

# Links in the footer (optional)
footer:
  # Header of the column
  Learn:
    - Introduction /
    - Installation /getting-started/installation
  Community:
   - Discord https://discord.gg/XJMMSSC4Fj
   - Support https://github.com/lino-levan/pyro/issues/new

# Hide the navigation bar on the left from rendering (optional)
hide_navbar: true

# Any plugins you want to be used (optional)
plugin:
  - https://deno.land/x/pyro/plugins/demo.tsx

How do I configure individual pages?

You can configure individual page metadata using markdown frontmatter. We support yaml/toml/json/jsonc.

Here is an example in YAML:

---
title: Title of Page
description: Metadata description of page
hide_navbar: true
index: 0
---

title - The title of the page which also shows up as a large header
description - The description of the page for SEO and embeds
hide_navbar - Hide the navbar from this page
index - Used in determining sidebar order