Doctave Flavored Markdown

Doctave supports your basic Markdown features, plus some custom extensions to bring more structure to your docs.

You can read about the basics of Markdown here.

Callouts

You can bring attention to sections using callouts.

Basic usage

{% info This is the title %}

And this is the content!

So much space for activities!

{% end %}

Gives you:

This is the title

And this is the content!

So much space for activities!

Without a title

{% info %}

You can skip the title

{% end %}

Gives you:

You can skip the title

Types

Instead of info, you can use success, warning, or error for different colored callouts:

A success message

This is positive news

A warning message

You should use caution

An error message

Something went wrong

Emojis

You can use GitHub style shortcodes for emojis.

This means you can write :bell: and Doctave will render is as 🔔. These work particularly well with callouts (see below):

⚡ I want your attention

This is important!

Syntax highlighting

You can specify the language for syntax highlighting using the backticks syntax.

```ruby
def initialize(table_name_singularised)
    @table = table_name_singularised.to_s.pluralize
end
```
def initialize(table_name_singularised)
    @table = table_name_singularised.to_s.pluralize
end

Tables

Tables work the same as in GitHub Flavored Markdown.

This is a heading              | This is another heading  |
-------------------------------|--------------------------|
This is content for a columns  | This is **bold**         |
You can have more rows         | And more columns         |
This is a headingThis is another heading
This is content for a columnsThis is bold
You can have more rowsAnd more columns

Task Lists

You can tasks lists for checklists or tracking progress of a project:

- [ ] This is a list of todos
- [x] This is a completed item
- [ ] This is an uncompleted item
  • This is a list of todos
  • This is a completed item
  • This is an uncompleted item