From d224172a31a74e42188ae6f1fd0150688bba8f3b Mon Sep 17 00:00:00 2001 From: mffap Date: Thu, 4 May 2023 16:03:07 +0200 Subject: [PATCH] docs(contrib): fix headings, add embedded code (#5752) --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b17d42c0ab..6d35289418 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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(): ` as title for the semantic release.