OXY2DEV / markview.nvim

☄️ Markview.nvim A hackable Markdown , HTML , LaTeX , Typst & YAML previewer for Neovim. | | | |---------------|----------------| | | | 📚 Wiki | 🧩 Extras | 📦 Presets ✨ Features Core features, • Preview , HTML , $LaTeX$, & (See integrations#Asciidoc) within Neovim. • *Hybrid* editing mode! Allowing *editing* & *previewing* at the same time. • *Splitview*! Allows editing & previewing *side-by-side*. • support(markdown only, at the moment)! Allows using text wrapping while not losing *most* rendering features! See integrations#wrap for fixing visual glitches or integrations#nowrap for disabling it. • Highly customisable! You can change almost anything using the config! • Dynamic that automatically updates with the colorscheme! • , completions for & . • Works with too! 📚 Table of contents • 📚 Requirements • 📐 Installation • 🎇 Commands Also see, • 📚 Wiki • 💡 Configuration • 🧭 Usage • 🧩 Extras • 📦 Presets 📜 Complete feature-list Expand to see complete feature list Asciidoc Supported syntax, • Admonitions • Checkboxes(also supports custom checkbox states). • Horizontal rules • Literal blocks • Hiding document attributes • Image macros • Keycode macros • List items(ordered & unordered) • Automated TOC(Table of Contents) Asciidoc inline Supported syntax, • Bold • Highlights • Italic • Monospace • URI Fancy comments, > Comments are still experimental! The original parser only supports basic features. Conventional commit style comments with support for a subset of & . See integrations#fancy-comments For more info. Supported syntax, • Tasks(e.g. , etc.) • Task scopes. Extra syntax(needs external parser), • • • • • • • • • • Code blocks HTML, • Customizable previews for & elements. • Supports the following container elements out of the box, • + • + • + • + • , , • + • + • Supports the following void elements out of the box, • + LaTeX, • Supports basic LaTeX syntax, • Math blocks(typically ) & inline math(typically ). • Escaped characters. • Math fonts • Math symbols. • . • Supports commonly used math commands out of the box, • + • + • + • + • + • + • + • + • + • + • + • + • + • + • + • + • + • + • + • • Supports the following math fonts(requires any *modern* Unicode font), • (Default math font). • + • + • + • + • + • + • Supports Unicode based *subscript* & *superscript* texts. • Supports **2056** different math symbol definitions. Markdown, • Supports basic markdown(Github-flavored) syntax, • Block quotes(with support for & titles). • Fenced code blocks. • Headings( & ). • Horizontal rules. • List items( , , , & ). • Minus & plus metadata. • Reference link definitions. • Tables. • Checkboxes(supports *minimal-style* checkboxes). • Email links. • Entity references. • Escaped characters. • Footnotes. • Hyperlinks. • Images. • Inline codes/Code spans. • Autolinks • support for, • Block quotes & Callouts. • Sections(when is used). • List items(when is true). • (limited due to technical limitations). • like indentation for headings. • Obsidian/PKM extended syntax support, • Block reference links. • Embed file links. • Internal links(supports *aliases*). • Wide variety of HTML entity names & codes support. • Supported named entities: **786**. • Supported entity codes • Github emoji shorthands support. Supports **1920** shorthands. • Custom configuration based on link patterns. Typst, • Supports the following items, • Code blocks. • Code spans. • Escaped characters. • Headings. • Labels. • List items( , & ). • Math blocks. • Math spans. • Raw blocks. • Raw spans. • Reference links. • Subscripts. • Superscripts. • Symbols. • Terms. • URL links. • Supports a variety of typst symbols, • Symbol entries: **932** • Symbol shorthands: **40** • Supports Unicode based *subscript* & *superscript* texts. YAML, • Custom property icons. • Custom property scope decorations. • Custom icons(/decorations) based on property type & value(e.g. ). • Supports the following properties out of the box, • tags. • aliases. • cssclasses. • publish. • permalink. • description. • images. • cover. --- Hybrid mode | Normal hybrid mode | Linewise hybrid mode | |--------------------|----------------------| | | | • *Node-based* edit range(default). Clears a range of lines covered by the (named) under the cursor. Useful when editing lists, block quotes, code blocks, tables etc. • *Range-based* edit range. Clears the selected number of lines above & below the cursor. • Supports multi-window setups. Splitview • View previews in a separate window. • Scroll sync between raw file & preview window. Others Internal Icon provider features, • **708** different filetype configuration. • Dynamic highlight groups for matching the colorscheme. • You can use to see what the plugin has been doing(including how long some of them took). • You can also use to export these logs. 📚 Requirements System, • **Neovim:** >= 0.10.3 >[!NOTE] > It is recommended to use (though there is wrap support in the plugin) & . --- Colorscheme, • Any *tree-sitter* based colorscheme is recommended. External icon providers, >[!NOTE] > You need to change the config to use the desired icon provider. > > • mini.icons • nvim-web-devicons Parsers, >[!TIP] > You can use to easily install parsers. You can install all the parsers with the following command, > > >[!IMPORTANT] > On windows, you might need CLI for the $LaTeX$ parser. • • • (optional) • (optional) • (optional) • (optional) • (optional) • tree-sitter-asciidoc(optional) See integrations#Asciidoc to see how to get started. Fonts, • Any *modern* Unicode font is required for math symbols. • *Nerd fonts* are recommended. >[!TIP] > It is recommended to run after installing the plugin to check if any potential issues exist. 📐 Installation 🧩 Vim-plug Add this to your plugin list. 💤 Lazy.nvim >[!WARNING] > Do *not* lazy load this plugin as it is already lazy-loaded. Lazy-loading may cause **more time** for the previews to load when starting Neovim! The plugin should b…