https://github.com/oncomouse/markdown.nvim
https://github.com/oncomouse/markdown.nvim
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/oncomouse/markdown.nvim
- Owner: oncomouse
- Created: 2023-03-24T19:58:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-19T15:45:05.000Z (over 2 years ago)
- Last Synced: 2025-01-21T15:48:43.986Z (over 1 year ago)
- Language: Lua
- Size: 83 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Oncomouse's markdown.nvim plugin
This plugin combines a few features from other plugins while removing features I don't use:
1. The ability to do syntax-aware join (`J` and `gJ`) and newline (`o` and `O`).
* Newline supports extending block quotes and lists (both ordered and unordered).
* Join will remove syntax when joining lines.
2. Smart detab/tab:
* In insert mode, `` and `` will auto-increment ordered lists; `` with no whitespace will delete list marker
* In normal mode, `>`, `>>`, `<`, and `<<` will auto-increment ordered lists; `<` and `<<` with no whitespace will delete list marker
3. Smart delete: using `dd` or `d` will automatically trigger renumbering of ordered lists
4. All of the motion commands from [vim-markdown](https://github.com/preservim/vim-markdown).
5. Switch list type:
* In insert mode, `` will switch list type for the current line
* In normal mode, `mss` will switch list type for the current list
* `ms` will use `operatorfunc` to switch list type for a given motion
6. Renumber:
* In normal mode, `mn` will renumber an ordered list
## Configuring
Running `require("markdown").setup()` will create the necessary mappings in any buffer. By default, this loads for all markdown files, but you could use autocommands or other ftplugins to load the mappings elsewhere.
Several variables control the plugin's behavior:
* `vim.g.markdown_nvim_modules` -- Define the modules to load (default: `{ "markdown.detab", "markdown.join", "markdown.movements", "markdown.newline", "markdown.renumber", "markdown.switch", }`)
* `vim.b.markdown_nvim_modules` -- Load modules for a particular buffer
* `vim.g.markdown_nvim_unordered_default` -- Define the unordered token to use when switching ordered lists to unordered (default: `*`)
* `vim.b.markdown_nvim_unordered_default` -- Set for individual buffers
* `vim.g.markdown_nvim_do_not_set_default_maps` -- Set to `true` or `1` to prevent the creation of default mappings.
* `vim.b.markdown_nvim_do_not_set_default_maps` -- Disable default maps for an individual buffer
## Autopairs Support for markdown.nvim
This plugin does not insert list or blockquote characters on newline. Lists can be managed using [autolist.nvim](https://github.com/gaoDean/autolist.nvim); block quotes might be extending using any of the available autopairs plugins.
I use [lexima.vim](https://github.com/cohama/lexima.vim) for autopairs, and the following rules supplement this plugin:
```lua
-- Blockquotes:
vim.fn["lexima#add_rule"]({
char = "",
input = "",
at = [[^> \%#]],
filetype = "markdown",
})
vim.fn["lexima#add_rule"]({
char = "",
at = [[^> .\+\%#$]],
input = "> ",
filetype = "markdown",
})
vim.fn["lexima#add_rule"]({
char = "",
at = [[^> \%#$]],
input = "",
filetype = "markdown",
})
vim.fn["lexima#add_rule"]({
char = ">",
input = "> ",
at = [[^\%#]],
filetype = "markdown",
})
-- Unordered Lists:
vim.fn["lexima#add_rule"]({
char = "",
at = [[^\s*\([*-]\).*\%#$]],
filetype = "markdown",
with_submatch = true,
input = [[\1 ]],
except = [[^\s*\([*-]\) \%#$]],
})
vim.fn["lexima#add_rule"]({
char = "",
at = [[^\s*[*-] \%#$]],
filetype = "markdown",
input = [["_D]],
})
vim.fn["lexima#add_rule"]({
char = "",
at = [[^\(\s*\)[*-] \%#$]],
filetype = "markdown",
with_submatch = true,
input = [["_D\1]],
})
-- Ordered Lists (including automatic increment):
vim.fn["lexima#add_rule"]({
char = "",
at = [[^\s*\([0-9]\+\)\..*\%#$]],
filetype = "markdown",
with_submatch = true,
input = [[\1. :exec "normal! \" "$"]],
except = [[^\s*\([0-9]\)\. \%#$]],
})
vim.fn["lexima#add_rule"]({
char = "",
at = [[^\s*[0-9]\+\. \%#$]],
filetype = "markdown",
input = [["_D]],
})
vim.fn["lexima#add_rule"]({
char = "",
at = [[^\(\s*\)[0-9]\+\. \%#$]],
filetype = "markdown",
with_submatch = true,
input = [["_D\1]],
})
```
## Todo
1. [X] Binding to switch list type (from ordered to unordered).
2. [X] Binding to recalculate numbering for ordered lists
3. [X] Detab properly renumbers ordered lists
4. [X] Tab binding to properly renumber ordered lists
5. [X] Increment numbers on new ordered list
6. [X] Tab support for renumbering in normal mode (`>>`)
7. [X] Tab/detab with operator-pending support (`>`) for renumbering
8. [X] Delete module operator-pending support
9. [X] Visual delete
10. [X] Paste (`p`/`P`) support
11. [X] Visual paste (`p`/`P`) support
12. [X] `o`/`O` detect when line below/above is a list but current line isn't
13. [X] `vim.v.count1` support for opfunc-based delete
14. [X] Follow footnotes (references / definitions)
15. [X] Follow footnotes outside of current file
16. [X] Follow footnote definitions outside of current file
17. [ ] Update all of this to work with orgmode