HTML format

The title block, the navbar, and the grid.

Worked examples of the mcanouil-html options, and of the options whose value depends on whether a document is part of a website.

The Reference lists the format options. The Reference lists the document options.

A document

---
title: "My Document"
format: mcanouil-html
---

The layout style

---
title: "My Document"
format:
  mcanouil-html:
    style: academic
---

style is matched without regard to case, so Academic works, and any value that is not academic gives the professional layout.

The title block

The title block is built from three groups, and each one can be switched off.

---
title: "A paper"
author: "Mickaël CANOUIL"
date: last-modified
abstract: "One paragraph."
format:
  mcanouil-html:
    title-block-abstract: false
    title-block-meta: false
---

Switch off the groups whose metadata a page does not carry. A landing page with one author and no abstract reads better with title-block-abstract and title-block-meta off, which leaves the authors group alone.

Where a default comes from

A default is supplied by the project type or by the format, not by the filter that reads it. So the same option can differ between a website and a standalone document.

Where each value comes from.
Option In a website In a standalone document
hide-navbar-title true, from the project type. No value, so the navbar title stays visible.
grid-background false, from the project type. true, from the format.

A standalone document that wants the website behaviour writes it:

---
title: "My Document"
format: mcanouil-html
extensions:
  mcanouil:
    hide-navbar-title: true
    grid-background: false
---

The grid background

grid-background draws a faint grid behind the content.

extensions:
  mcanouil:
    grid-background: true

The option is read as text, so only the value true turns it on. One setting covers an HTML page and a Reveal.js slide background.

The Reference explains the order the three values are applied in.

Back to top