feature: Indent top-level unordered ("bulleted") list items

[proofer]

Is your feature request related to a problem? Please describe.

Unordered list items, e.g.,

| <-- left margin, if this were not a github markdown code block in order to render literal hyphens
- first item  
- second item

should be rendered indented, should't they?

Describe the solution you'd like

• first item
• second item

--Using github's markdown rendering to show what I'd like; the pre-rendering hyphens are at the left margin

Describe alternatives you've considered

I don't know what other solutions or features to consider, given that I otherwise like render-markdown.nvim a lot.

Additional information

No response

[proofer]

This works

    opts = {
        bullet = {
            left_pad = 4,
        },
    },

except the wrapped portion of a line-wrapped list item now doesn't indent nicely so that its first character is horizontally aligned with the first character of the item.

[MeanderingProgrammer]

I'm not trying to render the markdown like github or any other specific software by default. The default is really my personal preference, which is to strike a balance between what I consider looking nice, without shifting the text too much, I more or less like an overlay. That's why all the indentation features are off / set to zero by default. From there it's up to individuals to set the configuration to their preference.

I do have a notion of presets though: https://github.com/MeanderingProgrammer/render-markdown.nvim/blob/main/lua/render-markdown/presets.lua#L15, if you want to offer up a suggested config for github I'd be more than happy to add it :)

It looks like you found the left_pad option, is the issue now just about applying the padding to the entire list item, rather than just the first line?

[proofer]

is the issue now just about applying the padding to the entire list item, rather than just the first line?
Yes.

I ought to have found left_pad before posting, but I thought I'd leave the post as a lesson to others who don't take sufficient time to read the available opts. Thanks for your understanding.

[MeanderingProgrammer]

No worries, the configuration for this plugin is not easy to parse though. In general most components should support padding in some form or another.

Applying padding to all lines of list items should work after: 3adb9d5.

[proofer]

I updated with Lazy and its log now shows 3adb9d5 as the latest commit. I closed and re-opened an .md file that exhibited the wrap issue, but see no change. Is there something else I should do?

[proofer]

I should add that the instances I am seeing are not really dynamically wrapped but are multiple-line items. However, the issue does occur with dynamically-wrapped items, e.g., when resizing a window.

[MeanderingProgrammer]

Ah I thought you were referring to manual line breaks in markdown files, but you're taking about actual wrapped lines.

That's not something I can control in the plugin and is completely up to your neovim config for how line breaks are handled. Checkout:

• :help 'showbreak'
• :help 'breakindent'
• :help 'breakindentopt'

Likely what you want is for me to be able to add padding to line breaks equal to the added padding around the bullet point.

Unfortunately this is basically impossible.

[proofer]

I think that what I called dynamically wrapped you call actually wrapped -- your suggested :help references are about those; I understand that you can't handle those. And due undoubtedly to some operator error, while the image I posted above was indeed made after updating and closing-re-opening the .md file, now that I've closed-re-opened again I see that the pictured list items are handled perfectly.

So in the end I'm glad I made a small contribution the the plugin by posting the issue :)

[MeanderingProgrammer]

Ah gotcha, I wasn't sure how to describe the difference, maybe manually wrapped?

Anyway, glad we were on the same page and the fix works for you! I imagine there can be many reasons for an update not being picked up immediately.

I agree the new behavior is a much better way to handle padding list items. I think this might be a remanent from when I only handled the literal bullet point of list items.

Thanks for brining up the issue!