Skip to content

Checkboxes

MeanderingProgrammer edited this page Mar 24, 2025 · 10 revisions

Checkboxes

Raw data being used:

# Checkboxes

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

Default

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

Icons

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

State

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

Scope

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