Make comments actual comments
Some checks are pending
Publish / publish (push) Waiting to run

This commit is contained in:
david-swift 2025-02-25 14:29:59 +01:00
parent 86eea6d2b4
commit c9c86e5af0

View File

@ -100,7 +100,7 @@ Configuration variables from `config.toml` that can be set/overriden per page/se
- `styles`: Additional CSS styles; expects them to be in the `./static/` directory. If you are using Sass it will be generated there automatically. - `styles`: Additional CSS styles; expects them to be in the `./static/` directory. If you are using Sass it will be generated there automatically.
- `scripts`: Additional JavaScript scripts; expects them to be in the `./static/` directory. - `scripts`: Additional JavaScript scripts; expects them to be in the `./static/` directory.
- `katex`: Whether to enable the KaTeX library for rendering LaTeX. - `katex`: Whether to enable the KaTeX library for rendering LaTeX.
<--! TODO: Check table of contents --> <!-- TODO: Check table of contents -->
- `toc`: Enables table of contents. Only first 2 levels of headings are listed. - `toc`: Enables table of contents. Only first 2 levels of headings are listed.
- `toc_inline`: Whether to render inline table of contents at the top of all pages, in addition to floating quick navigation buttons. - `toc_inline`: Whether to render inline table of contents at the top of all pages, in addition to floating quick navigation buttons.
- `toc_ordered`: Whether to use numbered (ordered) list for table of contents. - `toc_ordered`: Whether to use numbered (ordered) list for table of contents.
@ -115,11 +115,11 @@ Other variables:
- `trigger`: Displays a trigger warning message. - `trigger`: Displays a trigger warning message.
- `disclaimer`: Displays a disclaimer message. - `disclaimer`: Displays a disclaimer message.
<--! TODO: Add instructions for documentation and subprojects --> <!-- TODO: Add instructions for documentation and subprojects -->
### Blog Post Specific ### Blog Post Specific
<--! TODO: Check archived/featured/hot/poor --> <!-- TODO: Check archived/featured/hot/poor -->
- `banner`: Filename of the [colocated](https://www.getzola.org/documentation/content/overview/#asset-colocation) banner image. Recommended dimensions are 2:1 aspect ratio and 1920x960 resolution. - `banner`: Filename of the [colocated](https://www.getzola.org/documentation/content/overview/#asset-colocation) banner image. Recommended dimensions are 2:1 aspect ratio and 1920x960 resolution.
- `banner_pixels` Makes the banner use nearest neighbor algorithm for scaling, useful for keeping pixel-art sharp. - `banner_pixels` Makes the banner use nearest neighbor algorithm for scaling, useful for keeping pixel-art sharp.