Skip to content

Commit

Permalink
docs(contrib): fix headings, add embedded code (#5752)
Browse files Browse the repository at this point in the history
  • Loading branch information
mffap committed May 4, 2023
1 parent 696fb39 commit d224172
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,13 +330,15 @@ docker compose down

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.

### 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.
- **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
When making a pull request use `docs(<scope>): <short summary>` as title for the semantic release.
Expand Down

1 comment on commit d224172

@vercel
Copy link

@vercel vercel bot commented on d224172 May 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docs – ./

zitadel-docs.vercel.app
docs-git-main-zitadel.vercel.app
docs-zitadel.vercel.app

Please sign in to comment.