Checkboxes

Checkboxes

Raw data being used:

# Checkboxes

- [ ] Unchecked
- [x] Checked
- [-] Todo
- [~] Custom

Default

require('render-markdown').setup({
    checkbox = {
        enabled = true,
        position = 'inline',
        unchecked = {
            icon = '󰄱 ',
            highlight = 'RenderMarkdownUnchecked',
            scope_highlight = nil,
        },
        checked = {
            icon = '󰱒 ',
            highlight = 'RenderMarkdownChecked',
            scope_highlight = nil,
        },
        custom = {
            todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo', scope_highlight = nil },
        },
    },
})

Custom Icons

require('render-markdown').setup({
    checkbox = {
        unchecked = { icon = '✘ ' },
        checked = { icon = '✔ ' },
        custom = { todo = { rendered = '◯ ' } },
    },
})

Custom State

require('render-markdown').setup({
    checkbox = {
        custom = {
            important = { raw = '[~]', rendered = '󰓎 ', highlight = 'DiagnosticWarn' },
        },
    },
})

Scope Highlight

require('render-markdown').setup({
    checkbox = {
        checked = { scope_highlight = '@markup.strikethrough' },
    },
})

Position Overlay

require('render-markdown').setup({
    checkbox = {
        position = 'overlay',
    },
})