Skip to main content

Examples

This page shows some of the special features that come out of the box in Doctave. You can view how this file is constructed by opening the examples.md file in your docs folder.

Diagrams​

Doctave comes with Mermaid.js support, which means you can create intricate diagrams directly in your Markdown files:

You can read more about Mermaid JS in the Doctave docs or by going through the Mermaid JS tutorials.

Syntax highlighting​

Syntax highlighting is provided by Prism and Doctave supports most popular languages out of the box.

impl Watcher {
    fn notify<S: Into<String>>(&self, path: PathBuf, msg: S) -> bool {
        self.channel.send((path, msg.into())).is_ok()
    }
}

You can refer to the Doctave Markdown reference to see how to use syntax highlighting.

Doctave automatically indexes all your pages and allows you to search for them without any 3rd party services. You can see the search bar at the top of the page - hit the s key, and you can start searching all the content of the site.

Note - the results are keyboard-friendly. Use either the tab key or arrow keys to navigate them.

Dark mode​

You can turn on dark mode by clicking on the button on the left side of the page - the one with the moon icon. Your browser will remember your selection for each Doctave site.