Add note to README and healthcheck for obsidian.nvim

## Details

A few issues have come up with conflicting UI behavior between
this plugin and obsidian.nvim. Add a note about this to the
README similar to vimwiki. Include conflicting plugins in healthcheck.

Add acknowledge_conflicts configuration field to avoid warning
message since we can't easily read the obsidian configuration.

Author: MeanderingProgrammer

Diff for: README.md

@@ -166,6 +166,8 @@ require('render-markdown').setup({
     -- Vim modes that will show a rendered view of the markdown file
     -- All other modes will be uneffected by this plugin
     render_modes = { 'n', 'c' },
+    -- Set to avoid seeing warnings for conflicts in health check
+    acknowledge_conflicts = false,
     exclude = {
         -- Buftypes ignored by this plugin, see :h 'buftype'
         buftypes = {},
@@ -740,6 +742,21 @@ The table below shows all the highlight groups with their default link
 > vim.treesitter.language.register('markdown', 'vimwiki')
 > ```
 
+## obsidian.nvim
+
+> [!NOTE]
+>
+> [obsidian.nvim](https://github.com/epwalsh/obsidian.nvim) provides UI functionality
+> that is enabled by default. While there may be a way to have the 2 work together,
+> for the foreseeable future only one of these plugins should be used for the UI.
+> If you choose this plugin disable the `obsidian.nvim` UI with:
+>
+> ```lua
+> require('obsidian').setup({
+>     ui = { enable = false },
+> })
+> ```
+
 ## Images
 
 > [!NOTE]

Diff for: doc/markdown-ecosystem.md

@@ -13,6 +13,9 @@ different functionality will clash.
 
 - [headlines.nvim](https://github.com/lukas-reineke/headlines.nvim) - Same high
   level idea and starting point of this plugin, but with different feature sets
+- [obsidian.nvim](https://github.com/epwalsh/obsidian.nvim) - While this plugin
+  has many more `obsidian` related features it also provides a UI enabled by
+  default that clashes with this plugin
 
 ## Render in Browser
 

Diff for: doc/render-markdown.txt

@@ -24,6 +24,7 @@ Table of Contents                          *render-markdown-table-of-contents*
 7. Colors                                             |render-markdown-colors|
 8. Info                                                 |render-markdown-info|
   - vimwiki                                     |render-markdown-info-vimwiki|
+  - obsidian.nvim                         |render-markdown-info-obsidian.nvim|
   - Images                                       |render-markdown-info-images|
   - Additional                               |render-markdown-info-additional|
 
@@ -206,6 +207,8 @@ Full Default Configuration ~
         -- Vim modes that will show a rendered view of the markdown file
         -- All other modes will be uneffected by this plugin
         render_modes = { 'n', 'c' },
+        -- Set to avoid seeing warnings for conflicts in health check
+        acknowledge_conflicts = false,
         exclude = {
             -- Buftypes ignored by this plugin, see :h 'buftype'
             buftypes = {},
@@ -829,6 +832,20 @@ VIMWIKI                                         *render-markdown-info-vimwiki*
       vim.treesitter.language.register('markdown', 'vimwiki')
   <
 
+OBSIDIAN.NVIM                             *render-markdown-info-obsidian.nvim*
+
+
+  [!NOTE]
+  obsidian.nvim <https://github.com/epwalsh/obsidian.nvim> provides UI
+  functionality that is enabled by default. While there may be a way to have the
+  2 work together, for the foreseeable future only one of these plugins should be
+  used for the UI. If you choose this plugin disable the `obsidian.nvim` UI with:
+  >lua
+      require('obsidian').setup({
+          ui = { enable = false },
+      })
+  <
+
 IMAGES                                           *render-markdown-info-images*
 
 

Diff for: lua/render-markdown/health.lua

@@ -20,8 +20,8 @@ function M.check()
     local latex_advice = 'Disable LaTeX support to avoid this warning by setting { latex = { enabled = false } }'
 
     vim.health.start('markdown.nvim [nvim-treesitter]')
-    local ok = pcall(require, 'nvim-treesitter')
-    if ok then
+    local has_treesitter = pcall(require, 'nvim-treesitter')
+    if has_treesitter then
         vim.health.ok('installed')
 
         M.check_parser('markdown')
@@ -46,6 +46,17 @@ function M.check()
     else
         vim.health.ok('none to check')
     end
+
+    vim.health.start('markdown.nvim [conflicts]')
+    if state.config.acknowledge_conflicts then
+        vim.health.ok('conflicts acknowledged')
+    else
+        M.check_plugin('headlines')
+        M.check_plugin('obsidian', {
+            'Ensure UI is disabled by setting ui = { enable = false } in obsidian.nvim config',
+            'Acknowledge conflicts to avoid this warning by setting { acknowledge_conflicts = true }',
+        })
+    end
 end
 
 ---@param minimum string
@@ -85,4 +96,17 @@ function M.check_executable(name, advice)
     end
 end
 
+---@param name string
+---@param advice string[]?
+function M.check_plugin(name, advice)
+    local has_plugin = pcall(require, name)
+    if not has_plugin then
+        vim.health.ok(name .. ': not installed')
+    elseif advice == nil then
+        vim.health.error(name .. ': installed')
+    else
+        vim.health.warn(name .. ': installed', advice)
+    end
+end
+
 return M

Diff for: lua/render-markdown/init.lua

@@ -113,6 +113,7 @@ local M = {}
 ---@field public log_level? 'debug'|'error'
 ---@field public file_types? string[]
 ---@field public render_modes? string[]
+---@field public acknowledge_conflicts? boolean
 ---@field public exclude? render.md.UserExclude
 ---@field public anti_conceal? render.md.UserAntiConceal
 ---@field public latex? render.md.UserLatex
@@ -189,6 +190,8 @@ M.default_config = {
     -- Vim modes that will show a rendered view of the markdown file
     -- All other modes will be uneffected by this plugin
     render_modes = { 'n', 'c' },
+    -- Set to avoid seeing warnings for conflicts in health check
+    acknowledge_conflicts = false,
     exclude = {
         -- Buftypes ignored by this plugin, see :h 'buftype'
         buftypes = {},

Diff for: lua/render-markdown/state.lua

@@ -84,6 +84,7 @@ function state.validate()
         log_level = one_of(config.log_level, { 'debug', 'error' }),
         file_types = string_array(config.file_types),
         render_modes = string_array(config.render_modes),
+        acknowledge_conflicts = { config.acknowledge_conflicts, 'boolean' },
         exclude = { config.exclude, 'table' },
         anti_conceal = { config.anti_conceal, 'table' },
         latex = { config.latex, 'table' },

Diff for: lua/render-markdown/types.lua

@@ -98,6 +98,7 @@
 ---@field public log_level 'debug'|'error'
 ---@field public file_types string[]
 ---@field public render_modes string[]
+---@field public acknowledge_conflicts boolean
 ---@field public exclude render.md.Exclude
 ---@field public anti_conceal render.md.AntiConceal
 ---@field public latex render.md.Latex