Configuration

This guide will help you configure renoun in your project.

renoun.json

The renoun.json file is used to globally configure components and utilities for the entire project. This file should be placed in the root of your project:

{
  "$schema": "https://renoun.dev/schema.json",
  "git": {
    "source": "https://github.com/souporserious/renoun"
  },
  "site": "https://renoun.dev",
  "theme": "theme.json"
}

Git Information

Renoun provides a simple way to integrate with Git. This allows you to view the commit history of your documentation site and see the changes made to each file:

{
  "git": {
    "source": "https://github.com/souporserious/renoun",
    "branch": "main",
    "provider": "github"
  }
}

Site

The site property is used to define the URL of your documentation site. This is used to generate the canonical URL for each page:

{
  "site": "https://renoun.dev"
}

Themes

Themes are powered by shiki and are used to define the themes used to highlight syntax in code blocks. You can create your own theme or use a pre-built theme:

{
  "theme": "theme.json"
}

Use an object to define multiple themes:

{
  "theme": {
    "dark": "themes/dark.json",
    "light": "themes/light.json"
  }
}