Checks
A build stops at the mistakes below and names the file of each, and in Markdown and CSS its line, as docs/2-guide/1-layout.md:12:. A mistake in a release starts with its tag, as release v1.2.3:, and names the file at its place in the docs folder. -serve stops at them when it starts. A mistake that you make while it serves shows in the page until you fix it.
Folders
- A docs folder without a group, as
1-get-started/. - A group without a page, and a group in a group.
- A Markdown file in a group without a position, as
1-install.md, and 2 entries of a folder with the same position. - 2 pages with the same URL, as
1-setup.mdand2-setup.md, the same file name in 2 groups of the same name, or1-index.mdnext toREADME.md. - A folder in
versions/not named after a minor version, asv1.2, one that matches no release, and a file inversions/outside such a folder. - A file that nothing uses: no page shows it, and no link or setting names it. A link of a template counts too. That catches an image that no page shows any more, and a page in a folder without a position, which the navigation would leave out. A file of a release folder counts if the release uses it. Hidden files don't count. In a docs folder at the root of the repository, only the groups count.
Front matter
- YAML that doesn't parse, a key that docpages doesn't know, and front matter without its closing
---. urlwithsource,urlwithouttitle, and asourceoutside the repository.- Site settings outside
docs/README.md,noteoutside theREADME.mdof a docs folder or a release folder, and a note of more than 1 paragraph. releaseswithoutfrom, afromthat isn't a minor version, asv1.2, and afromwithout a tag, as in a clone without tags.- A missing icon of the host, and a host without a name or a file URL.
Pages
- A page without a level 1 heading or a
title. - A link to a file or a folder that doesn't exist, as a page that you renamed.
- A link to a heading that its page lacks.
- An image or a video whose file doesn't exist, and an image of a release note outside the folder of the release.
- A code block in a language that Chroma doesn't highlight. A block without a language, a
mermaidblock and amathblock pass. - Raw HTML that the page would leave out: an element other than
<img>,<picture>,<source>,<video>,<audio>,<track>,<kbd>,<sup>,<sub>,<ins>,<br>,<details>and<summary>, an attribute other than those that pages keep, ajavascript:URL and text outside a<details>. A comment passes, which GitHub hides too. - Lines that start with
|but make no table, which needs a delimiter row as| --- | --- |below its first row, with as many cells. - A list item that CommonMark reads as text:
-itemor1.item, without the space after the marker, and a list that starts at another number than 1 right below a paragraph. A version as2.xand a year as2019.at the start of a line pass.
Templates
- A
.templfile of the docs folder that isn'tpackage docs, and.templfiles withouttempl DocpagesMain. - A
.templfile that templ can't read, and Go that doesn't compile, with the line and column in the.templor.gofile. - A link of a template to a file that doesn't exist or a heading that its page lacks.
.templfiles without the go command..templfiles in a docs folder without ago.modthat requires docpages, and ago.modthat Go can't read.- A
go.modthat requires a version of docpages that the running one isn't compatible with.
Stylesheet
esbuild reads style.css, which stops a build at what a browser would skip, with its line and column, as docs/style.css:12:3: "colr" is not a known CSS property (Did you mean "color" instead?):
- A
{or(that the file doesn't close, and a}that nothing opens. - A string without its end, and a comment without its
*/. - A declaration without its colon, as
color red;, and a rule without a selector. - A property that CSS doesn't have, as a typo. A custom property, as
--accent, and a name with a vendor prefix, as-webkit-line-clamp, pass. - An
@importafter other rules. - What esbuild passes and docpages checks: a declaration without a value, as
color: ;, and an at-rule that CSS doesn't have, as@meida.
Nesting passes, as in .card { &:hover { … } @media (…) { … } }.
Not checked
- Links to other sites.
- Whether the repository host has a linked file. A file that exists only in your working tree, as one that Git ignores, passes.
- The values of CSS properties, as
color: rde, and selectors.