https://github.com/iron-e/nvim-marktext
Bindings for Marktext's Markdown in Neovim
https://github.com/iron-e/nvim-marktext
latex lua markdown marktext mermaidjs neovim neovim-plugin nvim nvim-plugin snippets vimscript
Last synced: 3 months ago
JSON representation
Bindings for Marktext's Markdown in Neovim
- Host: GitHub
- URL: https://github.com/iron-e/nvim-marktext
- Owner: Iron-E
- License: other
- Created: 2021-12-01T01:32:54.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-21T23:13:42.000Z (almost 4 years ago)
- Last Synced: 2025-05-16T05:38:21.155Z (9 months ago)
- Topics: latex, lua, markdown, marktext, mermaidjs, neovim, neovim-plugin, nvim, nvim-plugin, snippets, vimscript
- Language: Lua
- Homepage:
- Size: 15.5 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nvim-markdown
`nvim-marktext` is a plugin that aims to provide improved functionality with [Marktext](https://marktext.app) and its enhanced markdown features.
It is not meant to replace existing markdown plugins, only enhance their functionality with specific additions for Marktext.
## Features
This plugin is still a work in progress. That said, it is in a good state for others to begin getting use out of it:
* Basic `mermaid` snippets
* [x] Class Diagrams
* [x] Entity Relationship Diagrams
* [x] Gantt
* [x] Graphs
* [x] Pie Charts
* [x] Sequence Diagrams
* [x] State Diagrams
* [x] User Journey Diagrams
* Basic Markdown snippets
* [x] Code Blocks
* [x] LaTeX Blocks
* [x] Tables
* [x] Manipulating columns
* [x] Initial generation
* [x] Links to helpful documentation from `:help`.
### Demo
This is a demo of most of the features. Read the [docs](./doc/marktext.txt) for more information.
* The theme in the demo is [nvim-highlite](https://github.com/Iron-E/nvim-highlite).
## Installation & Requirements
Requires the following:
* Neovim 0.7+
* [Marktext](https://marktext.app)
__Optionally__ requires the following:
* [nvim-libmodal](https://github.com/Iron-E/nvim-libmodal)
* `:MarktextMode`, which provides quick access to templates for various markdown blocks.
* [vim-markdown](https://github.com/plasticboy/vim-markdown/blob/master/ftplugin/markdown.vim)
* Automatic table formatting in `:MarktextMode`.
You can install it like any other plugin. Here is an example which uses `vim-plug`:
```vim
Plug 'Iron-E/nvim-libmodal'
Plug 'Iron-E/nvim-marktext'
Plug 'plasticboy/vim-markdown'
```