Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: improve contributing docs for code snippets #2546

Merged
merged 2 commits into from
May 20, 2024
Merged

docs: improve contributing docs for code snippets #2546

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf35ba7
docs: improve contributing docs for code snippets
mdelapenya May 20, 2024
1507498
chore: use placeholder
mdelapenya May 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions docs/contributing_docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,25 @@
The _Testcontainers for Go_ documentation is a static site built with [MkDocs](https://www.mkdocs.org/).
We use the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme, which offers a number of useful extensions to MkDocs.

In addition we use a [custom plugin](https://github.com/rnorth/mkdocs-codeinclude-plugin) for inclusion of code snippets.

We publish our documentation using Netlify.

## Adding code snippets

To include code snippets in the documentation, we use the [codeinclude plugin](https://github.com/rnorth/mkdocs-codeinclude-plugin), which uses the following syntax:

&lt;!--codeinclude--&gt;<br/>
&#91;Human readable title for snippet&#93;(./relative_path_to_example_code.go) block:someString<br/>
&#91;Human readable title for snippet&#93;(./relative_path_to_example_code.go) inside_block:someString<br/>
mdelapenya marked this conversation as resolved.
Show resolved Hide resolved
&lt;!--/codeinclude--&gt;<br/>

Where each title snippet in the same `codeinclude` block would represent a new tab
in the snippet, and each `targeting_expression` would be:

- `block:someString` or
- `inside_block:someString`

Please refer to the [codeinclude plugin documentation](https://github.com/rnorth/mkdocs-codeinclude-plugin) for more information.

## Previewing rendered content

### Using Python locally
Expand Down