Skip to content

Commit e82e110

Browse files
committed
Improve wording in guide
1 parent 15b6e47 commit e82e110

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

guide/src/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
- [Syntax highlighting](format/theme/syntax-highlighting.md)
1818
- [Editor](format/theme/editor.md)
1919
- [MathJax Support](format/mathjax.md)
20-
- [mdBook specific features](format/mdbook.md)
20+
- [mdBook-specific features](format/mdbook.md)
2121
- [Continuous Integration](continuous-integration.md)
2222
- [For Developers](for_developers/README.md)
2323
- [Preprocessors](for_developers/preprocessors.md)

guide/src/format/mdbook.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# mdBook-specific markdown
1+
# mdBook-specific features
22

33
## Hiding code lines
44

55
There is a feature in mdBook that lets you hide code lines by prepending them
6-
with a `#` [in the same way that Rustdoc does][rustdoc-hide].
6+
with a `#` [like you would with Rustdoc][rustdoc-hide].
77

88
[rustdoc-hide]: https://doc.rust-lang.org/stable/rustdoc/documentation-tests.html#hiding-portions-of-the-example
99

@@ -37,7 +37,7 @@ With the following syntax, you can include files into your book:
3737

3838
The path to the file has to be relative from the current source file.
3939

40-
mdBook will interpret included files as markdown. Since the include command
40+
mdBook will interpret included files as Markdown. Since the include command
4141
is usually used for inserting code snippets and examples, you will often
4242
wrap the command with ```` ``` ```` to display the file contents without
4343
interpretting them.

guide/src/format/theme/syntax-highlighting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Syntax Highlighting
22

3-
For syntax highlighting we use [Highlight.js](https://highlightjs.org) with a
4-
custom theme.
3+
mdBook uses [Highlight.js](https://highlightjs.org) with a
4+
custom theme for syntax highlighting.
55

66
Automatic language detection has been turned off, so you will probably want to
77
specify the programming language you use like this:

0 commit comments

Comments
 (0)