The kitrc.md file aka kitrc is the global configuration file of your app. It must reside at the root of your vault folder. The configuration is written in yaml syntax, inside the frontmatter block of the file.
The kitrc have to be exported like any other file, and is converted into kitrc.json at the root of the your kit folder.
This is what the kitrc.md file look like:
---
# kit configuration goes here
---
You can add text after the frontmatter configuration, it will not get exported in the kitrc.json file
Some configuration might look like the following:
# 📂 Vault
vault:
kit_folder: /Users/louis/mykitfolder
include:
- '^(kitrc|index|navbar).md$'
- '^blog/'
- '^notes/'
exclude:
- '^kit/'
- '^templates/'
- '^blog/draft'
# 🧰 Kit
kit:
version: latest
dirs: false
# 🖥️ Site
site:
name: PublishKit
description: Welcome to PublishKit
url: https://publishkit.dev
keyswords: publishkit, blogging, markdown
# 🔌 Plugins
plugins:
theme: "@default"
header: true
darkmode: true
navbar: true
toc: true
search: true
social: true
# ⚙️ Plugins settings
social:
github: https://publishkit.dev
discord: https://publishkit.dev