rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-12-20 22:29:12 +02:00
Code Issues Releases Activity

docs(style): Document mdbook-xgettext skip comment (#2929)

Browse Source
This commit is contained in:
Dmitri Gribenko
2025-09-27 11:13:16 +02:00
committed by GitHub
parent 00e3e194ae
commit 0a734e9f02
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
STYLE.md
View File

@@ -159,6 +159,10 @@ preprocessor, `mdbook-course`. The following conventions are mandatory:
**must** use the `{{%session outline%}}` or `{{%segment outline%}}` helpers.
- **File Includes:** Code for exercises and their solutions **must** be included
from external files using the standard `mdbook` `{{#include ...}}` helper.
- **Translation Directives:** To prevent an element (such as a paragraph, code
block, or list item) from being translated, place a
`<!-- mdbook-xgettext: skip -->` comment on a line by itself, followed by a
blank line, immediately before the element.
For a complete explanation of the custom helpers and all available frontmatter
fields, please refer to the [`mdbook-course` README](mdbook-course/README.md).