Skip to content

Headings

MeanderingProgrammer edited this page Sep 24, 2024 · 9 revisions

Headings

Raw data being used:

# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5

###### Heading 6

Default

require('render-markdown').setup({
    heading = {
        enabled = true,
        sign = true,
        position = 'overlay',
        icons = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
        signs = { '󰫎 ' },
        width = 'full',
        left_margin = 0,
        left_pad = 0,
        right_pad = 0,
        min_width = 0,
        border = false,
        border_virtual = false,
        border_prefix = false,
        above = '',
        below = '',
        backgrounds = {
            'RenderMarkdownH1Bg',
            'RenderMarkdownH2Bg',
            'RenderMarkdownH3Bg',
            'RenderMarkdownH4Bg',
            'RenderMarkdownH5Bg',
            'RenderMarkdownH6Bg',
        },
        foregrounds = {
            'RenderMarkdownH1',
            'RenderMarkdownH2',
            'RenderMarkdownH3',
            'RenderMarkdownH4',
            'RenderMarkdownH5',
            'RenderMarkdownH6',
        },
    },
})

Disable Sign

require('render-markdown').setup({
    heading = { sign = false },
})

Position Inline

require('render-markdown').setup({
    heading = { position = 'inline' },
})

Custom Icons

require('render-markdown').setup({
    heading = { icons = { '󰼏 ', '󰎨 ' } },
})

Width Block Padding

require('render-markdown').setup({
    heading = {
        width = 'block',
        left_pad = 2,
        right_pad = 4,
    },
})

Width Block Min Width

require('render-markdown').setup({
    heading = {
        width = 'block',
        min_width = 30,
    },
})

Width Block Center

require('render-markdown').setup({
    heading = {
        sign = false,
        position = 'inline',
        width = 'block',
        left_margin = 0.5,
        left_pad = 0.2,
        right_pad = 0.2,
    },
})

Width By Level

require('render-markdown').setup({
    heading = {
        width = { 'full', 'block', 'full', 'block' },
        min_width = 30,
    },
})

Border

require('render-markdown').setup({
    heading = { border = true },
})

Border Virtual

require('render-markdown').setup({
    heading = {
        border = true,
        border_virtual = true,
    },
})
Clone this wiki locally