1.4 KiB
1.4 KiB
title, tags, keywords, last_updated, summary, sidebar, permalink, category, weight
title | tags | keywords | last_updated | summary | sidebar | permalink | category | weight | |
---|---|---|---|---|---|---|---|---|---|
Syntax highlighting |
|
rouge, pygments, prettify, color coding, | March 20, 2016 | You can apply syntax highlighting to your code. This theme uses pygments and applies color coding based on the lexer you specify. | mydoc_sidebar | /mydoc_syntax_highlighting/ | Formatting | 9 |
About syntax highlighting
For syntax highlighting, use fenced code blocks optionally followed by the language syntax you want:
```ruby def foo puts 'foo' end ```
This looks as follows:
def foo
puts 'foo'
end
Fenced code blocks require a blank line before and after.
If you're using an HTML file, you can also use the highlight
command with Liquid markup:
{% raw %}
{% highlight ruby %} def foo puts 'foo' end {% endhighlight %}
{% endraw %}
It renders the same:
{% highlight ruby %} def foo puts 'foo' end {% endhighlight %}
The theme has syntax highlighting specified in the configuration file as follows:
highlighter: rouge
The syntax highlighting is done via the css/syntax.css file.
Available lexers
The keywords you must add to specify the highlighting (in the previous example, ruby
) are called "lexers." You can search for "lexers." Here are some common ones I use:
- js
- html
- yaml
- css
- json
- php
- java
- cpp
- dotnet
- xml
- http