feat: add presets for lazy & obsidian

## Details

Adds the notion of presets which provide partial configurations. The
order to resolve values is user configuration > preset > default
configuration.

There are 3 possible values:

- none: does nothing
- lazy: attempts to stay up to date with LazyVim distribution. If
  LazyVim ever uses a preset I'll need to figure something out.
- obsidian: currently sets rendering to all modes using anti conceal to
  show current line only. Will evolve over time to look more obsidian
  like.

Author: MeanderingProgrammer

README.md

@@ -130,6 +130,12 @@ require('render-markdown').setup({
     -- Milliseconds that must pass before updating marks, updates occur
     -- within the context of the visible window, not the entire buffer
     debounce = 100,
+    -- Pre configured settings that will attempt to mimic various target
+    -- user experiences. Any user provided settings will take precedence.
+    --  obsidian: mimic Obsidian UI
+    --  lazy: will attempt to stay up to date with LazyVim configuration
+    --  none: does nothing
+    preset = 'none',
     -- Capture groups that get pulled from markdown
     markdown_query = [[
         (atx_heading [

doc/render-markdown.txt

@@ -162,6 +162,12 @@ Full Default Configuration ~
         -- Milliseconds that must pass before updating marks, updates occur
         -- within the context of the visible window, not the entire buffer
         debounce = 100,
+        -- Pre configured settings that will attempt to mimic various target
+        -- user experiences. Any user provided settings will take precedence.
+        --  obsidian: mimic Obsidian UI
+        --  lazy: will attempt to stay up to date with LazyVim configuration
+        --  none: does nothing
+        preset = 'none',
         -- Capture groups that get pulled from markdown
         markdown_query = [[
             (atx_heading [

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local M = {}
 
 ---@private
 ---@type string
-M.version = '6.0.2'
+M.version = '6.0.3'
 
 function M.check()
     vim.health.start('render-markdown.nvim [version]')

lua/render-markdown/init.lua

@@ -133,6 +133,7 @@ local M = {}
 ---@field public win_options? table<string, render.md.UserWindowOption>
 
 ---@class (exact) render.md.UserConfig: render.md.UserBufferConfig
+---@field public preset? 'none'|'lazy'|'obsidian'
 ---@field public markdown_query? string
 ---@field public markdown_quote_query? string
 ---@field public inline_query? string
@@ -154,6 +155,12 @@ M.default_config = {
     -- Milliseconds that must pass before updating marks, updates occur
     -- within the context of the visible window, not the entire buffer
     debounce = 100,
+    -- Pre configured settings that will attempt to mimic various target
+    -- user experiences. Any user provided settings will take precedence.
+    --  obsidian: mimic Obsidian UI
+    --  lazy: will attempt to stay up to date with LazyVim configuration
+    --  none: does nothing
+    preset = 'none',
     -- Capture groups that get pulled from markdown
     markdown_query = [[
         (atx_heading [
@@ -500,7 +507,7 @@ function M.setup(opts)
     -- has already been initialized by the user.
     local state = require('render-markdown.state')
     if not state.initialized() or vim.tbl_count(opts or {}) > 0 then
-        state.setup(M.default_config, opts)
+        state.setup(M.default_config, opts or {})
         state.invalidate_cache()
         require('render-markdown.ui').invalidate_cache()
     end

lua/render-markdown/presets.lua

@@ -0,0 +1,33 @@
+---@class render.md.Presets
+local M = {}
+
+---@param user_config render.md.UserConfig
+---@return render.md.UserConfig
+function M.get(user_config)
+    local name = user_config.preset
+    if name == 'obsidian' then
+        ---@type render.md.UserConfig
+        return {
+            render_modes = { 'n', 'v', 'i', 'c' },
+        }
+    elseif name == 'lazy' then
+        ---https://github.com/LazyVim/LazyVim/blob/main/lua/lazyvim/plugins/extras/lang/markdown.lua
+        ---@type render.md.UserConfig
+        return {
+            file_types = { 'markdown', 'norg', 'rmd', 'org' },
+            code = {
+                sign = false,
+                width = 'block',
+                right_pad = 1,
+            },
+            heading = {
+                sign = false,
+                icons = {},
+            },
+        }
+    else
+        return {}
+    end
+end
+
+return M

lua/render-markdown/state.lua

@@ -1,3 +1,4 @@
+local presets = require('render-markdown.presets')
 local util = require('render-markdown.util')
 
 ---@type table<integer, render.md.BufferConfig>
@@ -22,9 +23,9 @@ function M.initialized()
 end
 
 ---@param default_config render.md.Config
----@param user_config? render.md.UserConfig
+---@param user_config render.md.UserConfig
 function M.setup(default_config, user_config)
-    local config = vim.tbl_deep_extend('force', default_config, user_config or {})
+    local config = vim.tbl_deep_extend('force', default_config, presets.get(user_config), user_config)
     M.config = config
     M.enabled = config.enabled
     M.log_level = config.log_level
@@ -337,6 +338,7 @@ function M.validate()
         link = { config.link, 'table' },
         sign = { config.sign, 'table' },
         win_options = { config.win_options, 'table' },
+        preset = one_of(config.preset, { 'none', 'lazy', 'obsidian' }, {}, false),
         markdown_query = { config.markdown_query, 'string' },
         markdown_quote_query = { config.markdown_quote_query, 'string' },
         inline_query = { config.inline_query, 'string' },

lua/render-markdown/types.lua

@@ -122,6 +122,7 @@
 ---@field public win_options table<string, render.md.WindowOption>
 
 ---@class (exact) render.md.Config: render.md.BufferConfig
+---@field public preset 'none'|'lazy'|'obsidian'
 ---@field public markdown_query string
 ---@field public markdown_quote_query string
 ---@field public inline_query string