From d6ea4e3f7a16f5531452a46a9775ef0108cd5029 Mon Sep 17 00:00:00 2001 From: Camelid Date: Sat, 27 Feb 2021 20:17:36 -0800 Subject: [PATCH] docs: Use inline code for regex And fix a typo. --- guide/src/format/mdbook.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/guide/src/format/mdbook.md b/guide/src/format/mdbook.md index d9bf89f0..a9221ee1 100644 --- a/guide/src/format/mdbook.md +++ b/guide/src/format/mdbook.md @@ -40,7 +40,7 @@ The path to the file has to be relative from the current source file. mdBook will interpret included files as Markdown. Since the include command is usually used for inserting code snippets and examples, you will often wrap the command with ```` ``` ```` to display the file contents without -interpretting them. +interpreting them. ````hbs ``` @@ -49,7 +49,7 @@ interpretting them. ```` ## Including portions of a file -Often you only need a specific part of the file e.g. relevant lines for an +Often you only need a specific part of the file, e.g. relevant lines for an example. We support four different modes of partial includes: ```hbs @@ -68,8 +68,8 @@ consisting of lines 2 to 10. To avoid breaking your book when modifying included files, you can also include a specific section using anchors instead of line numbers. An anchor is a pair of matching lines. The line beginning an anchor must -match the regex "ANCHOR:\s*[\w_-]+" and similarly the ending line must match -the regex "ANCHOR_END:\s*[\w_-]+". This allows you to put anchors in +match the regex `ANCHOR:\s*[\w_-]+` and similarly the ending line must match +the regex `ANCHOR_END:\s*[\w_-]+`. This allows you to put anchors in any kind of commented line. Consider the following file to include: