Fix-681 (#954)
* Adding section for code snippets. * Reformatting sections. * Update mdbook.md
This commit is contained in:
parent
07830f7f11
commit
84d4063e4a
|
@ -35,10 +35,20 @@ With the following syntax, you can include files into your book:
|
||||||
|
|
||||||
The path to the file has to be relative from the current source file.
|
The path to the file has to be relative from the current source file.
|
||||||
|
|
||||||
Usually, this command is used for including code snippets and examples. In this
|
mdBook will interpret included files as markdown. Since the include command
|
||||||
case, oftens one would include a specific part of the file e.g. which only
|
is usually used for inserting code snippets and examples, you will often
|
||||||
contains the relevant lines for the example. We support four different modes of
|
wrap the command with ```` ``` ```` to display the file contents without
|
||||||
partial includes:
|
interpretting them.
|
||||||
|
|
||||||
|
````hbs
|
||||||
|
```
|
||||||
|
\{{#include file.rs}}
|
||||||
|
```
|
||||||
|
````
|
||||||
|
|
||||||
|
## Including portions of a file
|
||||||
|
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
|
```hbs
|
||||||
\{{#include file.rs:2}}
|
\{{#include file.rs:2}}
|
||||||
|
|
Loading…
Reference in New Issue