prometheus/docs
1
0
Fork 0
mirror of https://github.com/prometheus/docs.git synced 2026-02-05 06:45:01 +01:00
Code Issues Releases Activity

Clarify inter-document linking in Markdown guide

Browse Source 
Signed-off-by: Julius Volz <julius.volz@gmail.com>
This commit is contained in:
Julius Volz
2025-05-26 15:50:36 +02:00
parent 9709911eda
commit 6672bdcfd7
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
markdown-guide.md
View File

@@ -25,6 +25,16 @@ For blog posts and documentation pages, please use headings in the following way
* **DO NOT use any top-level headings (`# Heading`, `<h1>`) in the Markdown content itself.** The final rendered page will include an automatic H1 heading based on the `title` frontmatter field.
* Use second-level headings (`## Heading`, `<h2>`) for the main sections of the blog post and use lower-level headings for subsections as appropriate.
### Links between pages
When linking *between* documentation pages, use the following rules:
* When linking between docs within the same repository:
* Use either a full repo-rooted path (`/docs/concepts/data_model.md`) or a relative file path (`../guides/utf8.md`) in such a way that the link also works on GitHub.
* Note: Keep the `.md` extension in the link.
* When linking between docs that live in different source repos:
* Use absolute site URL paths that start with `/docs/...`, omit the `.md` extension, but end with a slash, e.g. `/docs/concepts/data_model/`.
## Frontmatter fields
The following frontmatter fields are available: