Front matter
A key that docpages doesn't know fails the build.
Any page
| Key | Value | What it does |
|---|---|---|
title |
Text | Replaces the level 1 heading in the navigation and the browser tab. |
suggested |
true |
Offers the page in the search before you type. |
source |
Path | Shows this Markdown file in place of the page. Links to the file lead to the page. |
url |
URL | Makes the entry a link off the site. Needs title, and can't go with source or on the README.md of the docs folder, which opens the site. |
The README.md of a version
In docs/README.md, and in the README.md of a release folder in versions/:
| Key | Value | What it does |
|---|---|---|
note |
Markdown | The note above every page of the version. None without it. |
Site settings
Only in docs/README.md:
| Key | Value | What it does |
|---|---|---|
name |
Text | The name of the project. Default: the last part of the repository URL. |
home |
URL | Where the logo leads, relative to the output folder. Default: the first page. |
repository |
URL | Your repository. Default: the URL of the Git remote origin. |
host |
Map | Where the repository is hosted: name, icon, file and dir. See Repository host. |
releases |
Map | The releases from Git tags: from, the oldest version that the site shows, as v1.2, and the optional prefix of the tags, as api/. None without it. See Versions. |
address |
URL | The URL of the deployed output folder, as https://me.github.io/project/. Adds sitemap.xml and 404.html, and makes canonical links absolute. See Address. |
The links of the header and the footer belong to a template.