Skip to content

Commit

Permalink
List supported Highlight.js languages in guide (#1345)
Browse files Browse the repository at this point in the history
* List supported Highlight.js languages in guide

Generated using the technique described in
#1275 (comment).

* Improve wording in guide
  • Loading branch information
camelid authored Sep 29, 2020
1 parent b77942d commit 4c951d5
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 9 deletions.
2 changes: 1 addition & 1 deletion guide/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
- [Syntax highlighting](format/theme/syntax-highlighting.md)
- [Editor](format/theme/editor.md)
- [MathJax Support](format/mathjax.md)
- [mdBook specific features](format/mdbook.md)
- [mdBook-specific features](format/mdbook.md)
- [Continuous Integration](continuous-integration.md)
- [For Developers](for_developers/README.md)
- [Preprocessors](for_developers/preprocessors.md)
Expand Down
6 changes: 3 additions & 3 deletions guide/src/format/mdbook.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# mdBook-specific markdown
# mdBook-specific features

## Hiding code lines

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

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

Expand Down Expand Up @@ -37,7 +37,7 @@ 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.

mdBook will interpret included files as markdown. Since the include command
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.
Expand Down
61 changes: 56 additions & 5 deletions guide/src/format/theme/syntax-highlighting.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,67 @@
# Syntax Highlighting

For syntax highlighting I use [Highlight.js](https://highlightjs.org) with a
custom theme.
mdBook uses [Highlight.js](https://highlightjs.org) with a custom theme
for syntax highlighting.

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

<pre><code class="language-markdown">```rust
~~~markdown
```rust
fn main() {
// Some code
}
```</code></pre>
```
~~~

## Supported languages

These languages are supported by default, but you can add more by supplying
your own `highlight.js` file:

- apache
- armasm
- bash
- c
- coffeescript
- cpp
- csharp
- css
- d
- diff
- go
- handlebars
- haskell
- http
- ini
- java
- javascript
- json
- julia
- kotlin
- less
- lua
- makefile
- markdown
- nginx
- objectivec
- perl
- php
- plaintext
- properties
- python
- r
- ruby
- rust
- scala
- scss
- shell
- sql
- swift
- typescript
- x86asm
- xml
- yaml

## Custom theme
Like the rest of the theme, the files used for syntax highlighting can be
Expand Down

0 comments on commit 4c951d5

Please sign in to comment.