MeanderingProgrammer/render-markdown.nvim
Render Markdown.nvim
render-markdown.nvim is a Neovim plugin that transforms raw markdown syntax into a visually formatted layout directly inside the editor. It acts as a component visualizer and syntax highlighter, replacing standard markdown elements with custom symbols, icons, and formatted blocks to improve document readability.
The plugin provides a toggle between rendered visual layouts and raw text views, allowing users to switch based on their current needs. It also applies markdown styling to injected content sections found within non-markdown file types.
The system covers the visualization of various document elements, including tables rendered as grids, stylized callouts, checkboxes, and code blocks with configurable borders. It manages document hierarchy through heading styling, indentation guides, and vertical markers.
To maintain performance in large files, the renderer limits visual updates to the currently visible viewport.
Features
- Markdown Renderers - Transforms markdown syntax into a visually formatted layout with custom icons and colors directly inside Neovim.
- Markdown Renderers - Transforms raw markdown syntax into a visually formatted layout with icons, borders, and custom components directly inside the editor.
- Tree-Sitter Parsers - Uses tree-sitter grammars to precisely identify markdown elements for styling and icon placement.
- Markdown Documentation Tools - Improves the authoring experience with a visual hierarchy and assistive tools for checkboxes and callouts.
- Visual Heading Styles - Renders headers with custom icons, background colors, and borders to improve visual hierarchy.
- Component Visualizers - Replaces standard markdown elements with custom symbols and formatted blocks to improve readability.
- Callouts - Transforms callout syntax into visually distinct blocks with icons and colors to emphasize information.
- Markdown Checkbox Toggles - Visualizes markdown checkbox states using distinct icons for unchecked, checked, and todo items.
- Markdown and Syntax Highlighting - Enhances the visual hierarchy of documents using custom heading styles and indentation guides.
- Markdown Table Visualizers - Transforms plain text pipe tables into formatted visual grids using custom borders and padding.
- Editor Virtual Text Overlays - Overlays icons and decorations as virtual text without modifying the actual content of the buffer.
- Document Structure Navigators - Uses visual indentation guides and heading styles to clarify the structural depth of the document.
- Code Block Styling - Enhances code blocks with configurable borders, language labels, and background padding.
- Viewport-Based Renderers - Optimizes performance in large files by updating only the lines currently visible in the viewport.
- Large Dataset Optimizations - Restricts rendering to the visible screen range to maintain performance when displaying large files.
- Editor Markdown Enhancements - Provides a suite of features for rendering tables, callouts, and checkboxes with a raw/rendered view toggle.
- Markdown Table Rendering - Transforms plain text pipe tables into formatted visual grids with borders and padding.
- Editor View Toggles - Provides the ability to switch between a rendered visual layout and a raw text view.
- Source-Render Toggles - Includes a toggle to switch between raw markdown source and the rendered visual layout.
- Hierarchical Indentation Guides - Implements hierarchical padding and vertical guides based on the depth of the parent heading.
- Indentation Visualizers - Displays visual indentation guides for nested content to clarify the structural hierarchy of the document.
- Gutter Customizations - Adds distinctive icons and highlights in the editor gutter to mark specific document elements.
- Document Management - Improves the rendering of Markdown files.
