Documentation Request: YAML Frontmatter Format for Git Storage

[ChiragMoradiya]

Background

I'm working on integrating Wiki.js into our development workflow where we want to leverage Git as the primary content source. Our use case involves AI-assisted PRD (Product Requirements Document) generation where we:

1. Conduct discovery phase discussions
2. Use AI to generate structured markdown documents from those discussions
3. Commit these documents directly to our Git repository
4. Have Wiki.js automatically sync and display them

Current Challenge

While the [Git Storage documentation](https://docs.requarks.io/storage/git) explains how to configure bi-directional sync, I haven't been able to find official documentation on:

1. What is the exact YAML frontmatter format that Wiki.js expects when reading markdown files from Git?
2. Which metadata fields are supported in the frontmatter?
3. Which fields are required vs optional?
4. How does Wiki.js map file paths to page paths?

What I Need

Specifically, I need to know the complete frontmatter schema for manually creating markdown files in Git that Wiki.js will correctly import. For example:

---
title: ???
description: ???
tags: ???
published: ???
editor: ???
# What other fields are supported?
# Which fields are required?
---

# Page content here

Questions

1. Is there official documentation for the frontmatter format that I've missed?
2. What is the complete list of supported frontmatter fields for Git-synced content?
3. Are there any field validation rules I should be aware of (format, length limits, etc.)?
4. How does the path mapping work - is it purely based on file location in the repo, or can it be overridden via frontmatter?
5. What happens to custom frontmatter fields that aren't part of Wiki.js's standard schema - are they preserved or stripped?

Use Case Impact

This capability would enable:

• Automated documentation generation from various sources
• Integration with CI/CD pipelines for documentation-as-code workflows
• Better separation of content creation (Git) from content presentation (Wiki.js)
• AI-assisted content workflows where documents are generated programmatically

Workaround I'm Currently Using

Right now, my workaround is to:

1. Create a test page in Wiki.js UI
2. Check the Git repo to see what frontmatter was generated
3. Reverse-engineer the format

But this feels fragile and I'm concerned about:

• Missing undocumented fields or features
• Format changes in future versions
• Edge cases I haven't discovered yet

Request

Would it be possible to either:

1. Point me to existing documentation I've overlooked, or
2. Add a section to the docs specifically covering the frontmatter schema for Git storage, or
3. Share the authoritative schema/spec so the community can contribute documentation?

This would greatly help anyone looking to use Wiki.js as a presentation layer for Git-based content workflows.

Thank you!

---

Environment:

• Wiki.js Version: Latest
• Storage: Git (bi-directional sync)
• Git Provider: GitLab
• Deployment: Docker Swarm

[drumadrian]

hi @ChiragMoradiya

i'm new to wikiJS but so far I have found that git is for a backup of content.

The GraphQL API may be more friendly for creating pages programmatically

[ChiragMoradiya]

https://docs.requarks.io/storage/git explains about bi-directional sync. So, I thought this is one of the use-case supported.

[drumadrian]

i'm interested in the resolution 🤓

i hope you get the feature working 👍

[NGPixel]

While wiki.js will output a few more fields in the frontmatter when saving a file, only these fields will be imported back:

• title
• description
• tags
• isPublished