This repository has been archived on 2024-06-06. You can view files and clone it, but cannot push or open issues or pull requests.
vitrine/themes/reveal-hugo/exampleSite/content/highlightjs-linenumbers-example/_index.md
2022-01-05 23:28:57 +01:00

2.6 KiB

+++ title = "Reveal.js 3.9.0 highlighting example" outputs = ["Reveal"]

[reveal_hugo] theme = "white" highlight_theme = "vs" +++

Multiline highlighting with Highlight.js


This presentation shows the use of the new highlighting features which were introduced with Reveal.js v3.9.0.


Prerequisite

Disable codeFences in to your config.toml to prevent Hugo's built-in highlighting for code inside of --- fences.

{{< highlight toml "style=github" >}} [markup.highlight] codeFences = false {{< /highlight >}}


Theme

Specify a theme for Highlight.js in config.toml

{{< highlight toml "style=github" >}} [params.reveal_hugo] highlight_theme = "github" {{< /highlight >}}


...or in the _index.md front matter

{{< highlight toml "style=github" >}} [reveal_hugo] highlight_theme = "github" {{< /highlight >}}


Usage

The line highlighting is configured by adding {} immediately after the language selection of the markdown code block.

{{< highlight md >}}


{{< /highlight >}}


Just line numbers

{}

{{< highlight md >}}

package main
import "fmt"
func main() {
    fmt.Println("Hello world!")
}

{{< /highlight >}}

package main
import "fmt"
func main() {
    fmt.Println("Hello world!")
}

Highlight specific lines

{<line numbers separated by comma>}

{{< highlight md >}}

package main
import "fmt"
func main() {
    fmt.Println("Hello world!")
}

{{< /highlight >}}

package main
import "fmt"
func main() {
    fmt.Println("Hello world!")
}

Multi step highlight

{<line numbers separated by pipe>}

{{< highlight md >}}

package main
import "fmt"
func main() {
    fmt.Println("Hello world!")
}

{{< /highlight >}}

package main
import "fmt"
func main() {
    fmt.Println("Hello world!")
}

Hiding the line numbers

There is no Reveal.js parameter to use line highlighting without line numbers. However it can be achieved by adding the some custom CSS.

{{< highlight html "style=github" >}}

{{< /highlight >}}


💡 Put the custom CSS in either of these partials:

# for all presentations
layouts/partials/reveal-hugo/body.html
# for one presentation
layouts/partials/{presentation-name}/reveal-hugo/body.html

Thanks!