Skip to content

Update style-guide.md with information about doc_type front-matter field #4463

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 22, 2025
Merged

Update style-guide.md with information about doc_type front-matter field #4463

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion contribute/style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ sidebar_label: 'Using clickhouse-local database'
slug: /chdb/guides/clickhouse-local
description: 'Learn how to use a clickhouse-local database with chDB'
keywords: ['chdb', 'clickhouse-local']
doc_type: 'reference' (or 'guide' or 'changelog')
---
```

Expand All @@ -26,7 +27,7 @@ keywords: ['chdb', 'clickhouse-local']
There is a custom Docusaurus plugin which runs on build that makes the following
checks on front-matter:

- title, description and slug are specified.
- title, description, slug and doc_type (either `reference`, `guide`, `landingpage` or `changelog`) are specified.
- keywords use flow style arrays with single quoted items e.g.
`keywords: ['integrations']`
- single quotes are used for title, description, slug, sidebar_label
Expand Down