puck/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

add note on highlighting examples and syntax definitions

Browse source
This commit is contained in:
Valentin Gagarin 2023-10-25 12:01:17 +02:00
parent 3ca0dade5b
commit 00c90eae95
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/manual/src/contributing/documentation.md
View file

@ -151,6 +151,24 @@ Please observe these guidelines to ease reviews:
> This is a note.
```
Highlight examples as such:
````
> **Example**
>
> ```console
> $ nix --version
> ```
````
Highlight syntax definiions as such, using [EBNF](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form) notation:
````
> **Syntax**
>
> *attribute-set* = `{` [ *attribute-name* `=` *expression* `;` ... ] `}`
````
### The `@docroot@` variable
`@docroot@` provides a base path for links that occur in reusable snippets or other documentation that doesn't have a base path of its own.