doc/readme: clarify use of markdown features

Co-authored-by: Johannes Kirschbauer <hsjobeki+github@gmail.com>
This commit is contained in:
alex
2026-10-12 09:37:35 +02:00
committed by Johannes Kirschbauer
parent e6ca9b84c3
commit f0afffa6a1

View File

@@ -79,7 +79,7 @@ To test redirects, perform a browser refresh, as browsers do not re-run client J
The Nixpkgs manual follows a set of conventions.
* prose follows the [style guide](./styleguide.md);
* source file follows custom [markdown syntax](#syntax);
* source files can use the [supported markdown features](#syntax);
* technical writing follows [Diátaxis](https://nix.dev/contributing/documentation/diataxis).
### Writing Function Documentation