Skip to content

Commit 0a734e9

Browse files
authored
docs(style): Document mdbook-xgettext skip comment (#2929)
1 parent 00e3e19 commit 0a734e9

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

STYLE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,10 @@ preprocessor, `mdbook-course`. The following conventions are mandatory:
159159
**must** use the `{{%session outline%}}` or `{{%segment outline%}}` helpers.
160160
- **File Includes:** Code for exercises and their solutions **must** be included
161161
from external files using the standard `mdbook` `{{#include ...}}` helper.
162+
- **Translation Directives:** To prevent an element (such as a paragraph, code
163+
block, or list item) from being translated, place a
164+
`<!-- mdbook-xgettext: skip -->` comment on a line by itself, followed by a
165+
blank line, immediately before the element.
162166

163167
For a complete explanation of the custom helpers and all available frontmatter
164168
fields, please refer to the [`mdbook-course` README](mdbook-course/README.md).

0 commit comments

Comments
 (0)