Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metadata for every page #3480

Open
gingerwizard opened this issue Mar 11, 2025 · 0 comments · May be fixed by #3482
Open

Metadata for every page #3480

gingerwizard opened this issue Mar 11, 2025 · 0 comments · May be fixed by #3482
Assignees
Labels

Comments

@gingerwizard
Copy link
Contributor

Every page should have a metadata block at the top - unless a snippet.

This will aid automatic translations - modifications and incorrect formatting of this block is the most common issue.

should consist of:

---
slug: '/page/a_page'
title: 'a page'
description: 'A page'
---

Rules:

  • no preceeding whitespace
  • new line after last ---
  • title, slug and description mandatory
  • description used for search snippet.
  • sidebar_label and keywords optional (must be a list)
  • use single quotes on all values (mandatory as needed for some langs)
  • Single space between yaml key and value

This will be checked at build time on en and all translations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants