You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> Enhancing your Markdown editing experience in Neovim with intuitive shortcuts and commands.
6
+
> Enhancing your Markdown editing experience in Neovim with intuitive shortcuts and commands. ✍️
7
7
8
8
`markdown-tools.nvim` provides a set of commands and configurable keymaps to streamline common Markdown editing tasks, from inserting elements like headers and code blocks to managing checkbox lists and creating files from templates.
9
9
@@ -13,13 +13,13 @@ The markdown created, including the frontmatter, is compatible with [obsidian](h
13
13
14
14
## ✨ Features
15
15
16
-
-**Template Creation:** Create new Markdown files from predefined templates using your choice of picker (`fzf`, `telescope`, `snacks`). Automatically adds frontmatter with configurable placeholders (e.g., `alias`, `tags`).
17
-
-**Insert Markdown Elements:** Quickly add links, checkboxes, tables, headers, bold/italic/highlight text, code blocks (with language prompt), and more.
18
-
-**Visual Mode Integration:** Wrap selected text with bold, italic, links, or highlights.
19
-
-**Checkbox Management:** Insert new checkboxes (`- [ ]`) and toggle their state (`- [x]`).
-**Configurable:** Customize keymaps, enable/disable commands, set template directory, choose picker, and configure Markdown-specific buffer options.
22
-
-**Preview:** Preview command, using other auto-detected nvim plugins (see below) or default system application.
16
+
-**📝 Template Creation:** Create new Markdown files from predefined templates using your choice of picker (`fzf`, `telescope`, `snacks`). Automatically adds frontmatter with configurable placeholders (e.g., `alias`, `tags`).
17
+
-**🧱 Insert Markdown Elements:** Quickly add links, checkboxes, tables, headers, bold/italic/highlight text, code blocks (with language prompt), and more.
18
+
-**🎨 Visual Mode Integration:** Wrap selected text with bold, italic, links, or highlights.
19
+
-**✅ Checkbox Management:** Insert new checkboxes (`- [ ]`) and toggle their state (`- [x]`).
20
+
-**➡️ List Continuation:** Automatically continue Markdown lists (bulleted, numbered, checkbox) when pressing Enter.
21
+
-**🔧 Configurable:** Customize keymaps, enable/disable commands, set template directory, choose picker, and configure Markdown-specific buffer options.
22
+
-**👁️ Preview:** Preview command, using other auto-detected nvim plugins (see below) or default system application.
23
23
24
24
## ⚡️ Requirements
25
25
@@ -270,7 +270,7 @@ Default keymaps are provided (see Configuration). Use them in Normal or Visual m
270
270
-`<leader>mp`: Preview (if configured).
271
271
-`<leader>mnt`: Create new file from template.
272
272
273
-
### Creating Markdown Files from Templates
273
+
### Creating Markdown Files from Templates 📄
274
274
275
275
The `:MarkdownNewTemplate` command (default keymap `<leader>mnt`) allows you to create new Markdown files based on templates stored in your configured `template_dir`.
276
276
@@ -302,19 +302,19 @@ These generated values are then used in two ways:
302
302
- If it **does not** start with `---` AND the `insert_frontmatter` configuration option is `true` (the default), a new frontmatter block is automatically added to the beginning of the file. This block includes all fields (standard and custom) for which the generator function returned a non-nil value, formatted correctly in YAML. List values will be formatted like `tags: [tag1, tag2]`.
303
303
- If it **does** start with `---`, or if `insert_frontmatter` is `false`, no new frontmatter block is inserted. The template's existing frontmatter (with placeholders already replaced) is kept as is.
304
304
305
-
### List Continuation
305
+
### List Continuation ↩️
306
306
307
307
When `continue_lists_on_enter` is `true`, pressing `Enter` in a Markdown list item (bullet `*`, `-`, `+`; numbered `1.`; checkbox `- [ ]`, `- [x]`) will automatically insert the next list marker on the new line.
308
308
309
-
## Status
309
+
## 📈 Status
310
310
311
311
Stable. Contributions and suggestions are welcome.
312
312
313
-
## Contributing
313
+
## 🤝 Contributing
314
314
315
315
Please see CONTRIBUTING.md or open an issue/pull request.
316
316
317
-
## License
317
+
## 📜 License
318
318
319
319
Distributed under the MIT License. See `LICENSE` file for more information.
0 commit comments