docs(nxdev): add documentation on front matter support (#12531)

This commit is contained in:
Benjamin Cabanes 2022-10-11 16:48:03 -04:00 committed by GitHub
parent e89bc6bb12
commit 14bb9dd841
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,6 +2,19 @@
## Markdown syntax available
The default markdown syntax is supported when writing documentation.
### Front matter
Front matter is used to add metadata to your Markdown file (`title` & `description`). It is provided at the very top of the file, enclosed by three dashes `---`. The content is parsed as YAML.
If not Front matter is detected, the metadata will be populated with the following:
- `title`: first main title detected
- `description`: first paragraph detected
### Custom markdown syntax
The documentation website [nx.dev](https://nx.dev) is using custom Markdown syntax to enable the authors to add functionality to its content.
#### Callouts