TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-08-11 20:47:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(contrib): fix headings, add embedded code (#5752)

Browse Source
This commit is contained in:
mffap
2023-05-04 16:03:07 +02:00
committed by GitHub
parent 696fb390ae
commit d224172a31
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -330,13 +330,15 @@ docker compose down
Project documentation is made with docusaurus and is located under [./docs](./docs). Project documentation is made with docusaurus and is located under [./docs](./docs).
### Local Testing ### Local Testing
Please refer to the [README](./docs/README.md) for more information and local testing. Please refer to the [README](./docs/README.md) for more information and local testing.
### Style Guide ### Style Guide
- **Code with variables**: Make sure that code snippets can be used by setting environment variables, instead of manually replacing a placeholder. - **Code with variables**: Make sure that code snippets can be used by setting environment variables, instead of manually replacing a placeholder.
- **Embedded files**: When embedding mdx files, make sure the template ist prefixed by "_" (lowdash). The content will be rendered inside the parent page, but is not accessible individually (eg, by search). - **Embedded files**: When embedding mdx files, make sure the template ist prefixed by "_" (lowdash). The content will be rendered inside the parent page, but is not accessible individually (eg, by search).
- **Embedded code**: You can embed code snippets from a repository. See the [plugin](https://github.com/saucelabs/docusaurus-theme-github-codeblock#usage) for usage.
### Docs Pull Request ### Docs Pull Request
When making a pull request use `docs(<scope>): <short summary>` as title for the semantic release. When making a pull request use `docs(<scope>): <short summary>` as title for the semantic release.