Ayu and render-markdown

[pkazmier]

Thought I'd share one of my favorite colorschemes paired with my favorite markdown plugin.

My 'render-markdown' configuration:

  require("render-markdown").setup({
    file_types = { "markdown", "md", "codecompanion" },
    render_modes = { "n", "no", "c", "t", "i", "ic" },
    code = {
      sign = false,
      border = "thin",
      position = "right",
      width = "block",
      above = "▁",
      below = "▔",
      language_left = "█",
      language_right = "█",
      language_border = "▁",
      left_pad = 1,
      right_pad = 1,
    },
    heading = {
      sign = false,
      width = "block",
      backgrounds = {
        -- choose hlgroups where bg is the color you want your headings to be
        "MiniStatusLineModeVisual",
        "MiniStatusLineModeCommand",
        "MiniStatusLineModeReplace",
        "MiniStatusLineModeNormal",
        "MiniStatusLineModeOther",
        "MiniStatusLineModeInsert",
      },
      left_pad = 1,
      right_pad = 0,
      position = "right",
      icons = function(ctx) return (""):rep(ctx.level) .. "" end,
    },
  })

My relevant 'ayu' hl-group configuration:

        RenderMarkdownCode             = { bg = c.selection_inactive },
        RenderMarkdownCodeBorder       = { bg = c.selection_bg },
        RenderMarkdownCodeInline       = { fg = c.tag, bg = c.selection_inactive },
        RenderMarkdownH1               = { fg = c.accent },
        RenderMarkdownH2               = { fg = c.keyword },
        RenderMarkdownH3               = { fg = c.markup },
        RenderMarkdownH4               = { fg = c.entity },
        RenderMarkdownH5               = { fg = c.regexp },
        RenderMarkdownH6               = { fg = c.string },
        RenderMarkdownH1Bg             = { fg = c.bg, bg = c.accent },
        RenderMarkdownH2Bg             = { fg = c.bg, bg = c.keyword },
        RenderMarkdownH3Bg             = { fg = c.bg, bg = c.markup },
        RenderMarkdownH4Bg             = { fg = c.bg, bg = c.entity },
        RenderMarkdownH5Bg             = { fg = c.bg, bg = c.regexp },
        RenderMarkdownH6Bg             = { fg = c.bg, bg = c.string },
        ['@markup.heading']            = { fg = c.keyword, bold = true },
        ['@markup.heading.1']          = { fg = c.accent,  bold = true },
        ['@markup.heading.2']          = { fg = c.keyword, bold = true },
        ['@markup.heading.3']          = { fg = c.markup,  bold = true },
        ['@markup.heading.4']          = { fg = c.entity,  bold = true },
        ['@markup.heading.5']          = { fg = c.regexp,  bold = true },
        ['@markup.heading.6']          = { fg = c.string,  bold = true },
        ['@markup.strong']             = { fg = c.keyword, bold = true },
        ['@markup.italic']             = { fg = c.keyword, italic = true },
        ['@markup.list']               = { fg = c.vcs_added },
        ['@markup.raw']                = { fg = c.tag, bg = c.selection_inactive },
        ['@markup.quote']              = { fg = c.constant, italic = true },

[MeanderingProgrammer]

I don't know how this one slipped past, completely missed when you posted this, my bad.

That looks great, really cool use of the right aligned headings.

Thanks for sharing!

FYI for these repeated string type of icons you can use the function version instead of the list version. Functionally they're equivalent, up to you which you prefer.

In this case it would look like so:

require('render-markdown').setup({
    heading = {
        ---@param ctx render.md.heading.Context
        ---@return string?
        icons = function(ctx)
            return '' .. (''):rep(ctx.level)
        end,
    },
})

The type information, i.e. ---@param ... & ---@return ..., are completely optional, I just included them for completeness.

[pkazmier]

Thanks! I've updated my code in my configuration to use the function form.

[renodesper]

@pkazmier I tried using your config, but there is a visual issue. Do you happen to know why?

[pkazmier]

@pkazmier I tried using your config, but there is a visual issue. Do you happen to know why?

Try using a highlight group where the background and foreground are reversed. I find that a lot of status line themes already have a mode hlgroup defined that you could use (NORMAL, INSERT, etc). Or you can just define your own.