29 lines
743 B
Markdown
29 lines
743 B
Markdown
|
# Typographic conventions
|
||
|
|
|
||
|
|
The Zonemaster Backend documentation uses the following typographic conventions:
|
||
|
|
|
||
|
|
*Italic* text is used for:
|
||
|
|
|
||
|
|
* technical terms defined in the [Architecture] document
|
||
|
|
* data types defined in the [API] document
|
||
|
|
|
||
|
|
`Monospace` text is used for:
|
||
|
|
|
||
|
|
* snippets of JSON or sh
|
||
|
|
* JSON-RPC method names
|
||
|
|
* JSON values
|
||
|
|
* single or strings of characters
|
||
|
|
* internet addresses (e.g. domain names and IP addresses)
|
||
|
|
* file names with or without paths (e.g. configuration files and command line
|
||
|
|
tools)
|
||
|
|
* config section names
|
||
|
|
|
||
|
|
>
|
||
|
|
> Block quotes are used for:
|
||
|
|
>
|
||
|
|
> * notes and commentary
|
||
|
|
>
|
||
|
|
|
||
|
|
[API]: https://github.com/zonemaster/zonemaster/blob/master/docs/public/using/backend/rpcapi-reference.md
|
||
|
|
[Architecture]: Architecture.md
|