Markview.nvim
A hackable markdown, Typst, latex, html(inline) & Asciidoc previewer for Neovim
Install / Use
/learn @OXY2DEV/Markview.nvimREADME
| :set wrap | :set nowrap |
|---------------|----------------|
|
|
|
✨ Features
Core features,
- Preview
Markdown, <code>HTML</code>, $LaTeX$,Typst&Asciidoc(See integrations#Asciidoc) within Neovim. - Hybrid editing mode! Allowing editing & previewing at the same time.
- Splitview! Allows editing & previewing side-by-side.
Wrapsupport(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
highlight groupsthat automatically updates with the colorscheme! Callout,checkboxcompletions forblink.cmp&nvim-cmp.- Works with
tree-sitter injectionstoo!
📚 Table of contents
Also see,
📜 Complete feature-list
<details> <summary>Expand to see complete feature list</summary> <!--markdoc_ignore_end-->Asciidoc
<img src="https://github.com/OXY2DEV/markview.nvim/blob/images/v27/markview.nvim-asciidoc.png">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,
<img src="https://github.com/OXY2DEV/markview.nvim/wiki/images/comment/markview.nvim-comment.injection.png">Comments are still experimental! The original parser only supports basic features.
Conventional commit style comments with support for a subset of markdown & vimdoc. See integrations#fancy-comments For more info.
Supported syntax,
- Tasks(e.g.
feat,TODOetc.) - Task scopes.
Extra syntax(needs external parser),
**Bold***Italic*Code'Quoted_text'"Double quoted text"@mentionsissues/reference#52https://example.com|help-section|- Code blocks
HTML,
<img src="https://github.com/OXY2DEV/markview.nvim/blob/images/v25/repo/html-tokyonight_night.png">-
Customizable previews for
container&voidelements. -
Supports the following container elements out of the box,
<a></a><b></b><code></code><em></em><i></i><kbd></kbd><mark></mark><pre></pre><s></s>,<strike></strike>,<del></del><strong></strong><sub></sub><sup></sup><u></u>
-
Supports the following void elements out of the box,
<hr><br>
LaTeX,
<img src="https://github.com/OXY2DEV/markview.nvim/blob/images/v25/repo/latex-cyberdream.png">-
Supports basic LaTeX syntax,
- Math blocks(typically
$$...$$) & inline math(typically$...$). - Escaped characters.
- Math fonts
- Math symbols.
\text{}.
- Math blocks(typically
-
Supports commonly used math commands out of the box,
\frac{}\sin{}\cos{}\tan{}\sinh{}\cosh{}\tanh{}\csc{}\sec{}\cot{}\csch{}\sech{}\coth{}\arcsin{}\arccos{}\arctan{}\arg{}\deg{}\drt{}\dim{}\exp{}\gcd{}\hom{}\inf{}\ker{}\lg{}\lim{}\liminf{}\limsup{}\ln{}\log{}\min{}\max{}\Pr{}\sup{}\sqrt{}\lvert{}\lVert{}\boxed{}
-
Supports the following math fonts(requires any modern Unicode font),
default(Default math font).\mathbb{}\mathbf{}\mathbffrak{}\mathbfit{}\nathbfscr{}\mathcal{}\mathfrak{}\mathsf{}\mathsfbf{}\mathsfbfit{}\mathsfit{}\mathtt{}
-
Supports Unicode based subscript & superscript texts.
-
Supports 2056 different math symbol definitions.
Markdown,
<img src="https://github.com/OXY2DEV/markview.nvim/blob/images/v25/repo/markdown-catppuccin_mocha.png">-
Supports basic markdown(Github-flavored) syntax,
- Block quotes(with support for
callouts& titles). - Fenced code blocks.
- Headings(
setext&atx). - Horizontal rules.
- List items(
+,-,*,n.&n)). - 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
- Block quotes(with support for
-
Wrapsupport for,- Block quotes & Callouts.
- Sections(when
markdown.headings.org_indentis used). - List items(when
markdown.list_items.<item>.add_paddingis true). tables(limited due to technical limitations).
-
Org-modelike 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,
<img src="https://github.com/OXY2DEV/markview.nvim/blob/images/v25/repo/typst-kanagawa_wave.png">-
Supports the following items,
- Code blocks.
- Code spans.
- Escaped characters.
- Headings.
- Labels.
- List items(
-,+&n.). - 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,
<img src="https://github.com/
