alerts

New Settings Since v0.1.0

Linter: an alert tag is one of the allowed types and is followed by an empty > line.

Example#

doc.md:

> [!INFO]
> Restart the service after a change.

markright check reports:

doc.md:1: alert tag must be followed by an empty > line (alerts)
doc.md:1: unknown alert type [!INFO] (allowed: NOTE, TIP, IMPORTANT, WARNING, CAUTION) (alerts)
markright: 2 issue(s)

Fixed:

> [!NOTE]
>
> Restart the service after a change.

Settings#

Under linters.settings.alerts:

KeyMeaningDefault
typesAllowed alert typesNOTE, TIP, IMPORTANT, WARNING, CAUTION

With the defaults, in .markright.yaml:

linters:
  settings:
    alerts:
      types: [NOTE, TIP, IMPORTANT, WARNING, CAUTION]

or in .markright.toml:

[linters.settings.alerts]
types = ["NOTE","TIP","IMPORTANT","WARNING","CAUTION"]

Turning it off#

linters:
  disable: [alerts]
[linters]
disable = ["alerts"]

More in Rules.

Settings

Appearance

ThemeColours of every page

Reading

Code blocksLines longer than the block
TablesCells wider than the page

Accessibility

Text sizeEvery page, in proportion
LinksLinks inside the text
MotionAnimations and smooth scrolling
ScrollbarsCode blocks, tables and other scrolling areas