feat: add render-markdown.nvim for md workflow (#1336)

* feat: add `render-markdown.nvim` for md workflow * feat: `<F1>` toggles the plugin Signed-off-by: Jint-lzxy <[email protected]> * fix: add `nvim-web-devicons` as a dependency Signed-off-by: Jint-lzxy <[email protected]> * perf: disable for files larger than 2 MiB Signed-off-by: Jint-lzxy <[email protected]> --------- Signed-off-by: Jint-lzxy <[email protected]> Co-authored-by: Jint-lzxy <[email protected]>
ayamir · Aug 9, 2024 · ccf0464 · ccf0464
1 parent 3828f4b
commit ccf0464
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 0 deletions.
diff --git a/lua/keymap/lang.lua b/lua/keymap/lang.lua
@@ -5,6 +5,11 @@ local map_cr = bind.map_cr
 -- local map_callback = bind.map_callback
 
 local plug_map = {
+	-- Plugin render-markdown.nvim
+	["n|<F1>"] = map_cr("RenderMarkdown toggle")
+		:with_noremap()
+		:with_silent()
+		:with_desc("tool: toggle markdown preview within nvim"),
 	-- Plugin MarkdownPreview
 	["n|<F12>"] = map_cr("MarkdownPreviewToggle"):with_noremap():with_silent():with_desc("tool: Preview markdown"),
 }

diff --git a/lua/modules/configs/lang/render-markdown.lua b/lua/modules/configs/lang/render-markdown.lua
@@ -0,0 +1,21 @@
+return function()
+	require("modules.utils").load_plugin("render-markdown", {
+		-- Whether Markdown should be rendered by default or not
+		enabled = true,
+		-- Maximum file size (in MB) that this plugin will attempt to render
+		-- Any file larger than this will effectively be ignored
+		max_file_size = 2.0,
+		-- Milliseconds that must pass before updating marks, updates occur
+		-- within the context of the visible window, not the entire buffer
+		debounce = 100,
+		-- 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", "t" },
+		-- This enables hiding any added text on the line the cursor is on
+		-- This does have a performance penalty as we must listen to the 'CursorMoved' event
+		anti_conceal = { enabled = true },
+		-- The level of logs to write to file: vim.fn.stdpath('state') .. '/render-markdown.log'
+		-- Only intended to be used for plugin development / debugging
+		log_level = "error",
+	})
+end
diff --git a/lua/modules/configs/ui/catppuccin.lua b/lua/modules/configs/ui/catppuccin.lua
@@ -83,6 +83,7 @@ return function()
 			overseer = false,
 			pounce = false,
 			rainbow_delimiters = true,
+			render_markdown = true,
 			sandwich = false,
 			semantic_tokens = true,
 			symbols_outline = false,

diff --git a/lua/modules/plugins/lang.lua b/lua/modules/plugins/lang.lua
@@ -28,6 +28,15 @@ lang["Saecki/crates.nvim"] = {
 	config = require("lang.crates"),
 	dependencies = { "nvim-lua/plenary.nvim" },
 }
+lang["MeanderingProgrammer/render-markdown.nvim"] = {
+	lazy = true,
+	ft = "markdown",
+	config = require("lang.render-markdown"),
+	dependencies = {
+		"nvim-tree/nvim-web-devicons",
+		"nvim-treesitter/nvim-treesitter",
+	},
+}
 lang["iamcco/markdown-preview.nvim"] = {
 	lazy = true,
 	ft = "markdown",