Skip to content

Notes about writing docs

Arnim Läuger edited this page Jul 22, 2018 · 4 revisions

A collection of notes about writing NodeMCU docs

Admonitions

The following admonitions are supported: attention, caution, danger, error, hint, important, note, tip, warning. While they're all semantically different some are so close that they share the visual representation.

MkDocs & RTD admonition styles

The syntax in the .md files is

!!! caution

    This module is only in the very early stages and not complete yet.