mdbook/book-example/src/format/theme/syntax-highlighting.md

61 lines
1.9 KiB
Markdown
Raw Normal View History

# Syntax Highlighting
For syntax highlighting I use [Highlight.js](https://highlightjs.org) with a custom theme.
Automatic language detection has been turned off, so you will probably want to
specify the programming language you use like this
2015-12-30 15:04:24 +01:00
<pre><code class="language-markdown">```rust
fn main() {
// Some code
}
```</code></pre>
## Custom theme
2015-12-30 15:04:24 +01:00
Like the rest of the theme, the files used for syntax highlighting can be overridden with your own.
2015-12-30 15:04:24 +01:00
- ***highlight.js*** normally you shouldn't have to overwrite this file, unless you want to use a more recent version.
- ***highlight.css*** theme used by highlight.js for syntax highlighting.
If you want to use another theme for `highlight.js` download it from their website, or make it yourself,
rename it to `highlight.css` and put it in `src/theme` (or the equivalent if you changed your source folder)
Now your theme will be used instead of the default theme.
2015-12-30 15:04:24 +01:00
## Hiding code lines
There is a feature in mdBook that let's you hide code lines by prepending them with a `#`.
```bash
# fn main() {
2015-12-30 15:04:24 +01:00
let x = 5;
let y = 6;
println!("{}", x + y);
# }
2015-12-30 15:04:24 +01:00
```
Will render as
```rust
# fn main() {
2015-12-30 15:04:24 +01:00
let x = 5;
let y = 7;
println!("{}", x + y);
# }
2015-12-30 15:04:24 +01:00
```
**At the moment, this only works for code examples that are annotated with `rust`. Because it would collide with semantics of some programming languages. In the future, we want to make this configurable through the `book.toml` so that everyone can benefit from it.**
2015-12-30 15:04:24 +01:00
## Improve default theme
If you think the default theme doesn't look quite right for a specific language, or could be improved.
Feel free to [submit a new issue](https://github.com/rust-lang-nursery/mdBook/issues) explaining what you have in mind and I will take a look at it.
2015-12-30 15:04:24 +01:00
You could also create a pull-request with the proposed improvements.
Overall the theme should be light and sober, without to many flashy colors.