Skip to content

Commit 64fd599

Browse files
committed
chore(release): prepare for v1.0.0 release
Updates CHANGELOG.md with the changes for v1.0.0 and sets the release date.
1 parent b5deabc commit 64fd599

File tree

2 files changed

+31
-24
lines changed

2 files changed

+31
-24
lines changed

CHANGELOG.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
### Added
1313

14-
- Added default keybinding `<leader>mH` for inserting headers.
15-
- Added ability to use generator functions for frontmatter and placeholders in templates.
16-
1714
### Changed
1815

19-
- Updated health checks (`:checkhealth markdown-tools`).
20-
2116
### Deprecated
2217

2318
### Removed
2419

2520
### Fixed
2621

27-
- Fixed minor bugs to enhance performance.
28-
2922
### Security
3023

31-
## [0.1.0] - 2024-03-10
24+
## [1.0.0] - 2025-05-05
3225

3326
### Added
34-
27+
- Added default keybinding `<leader>mH` for inserting headers.
28+
- Added ability to use generator functions for frontmatter and placeholders in templates.
29+
- Added health checks (`:checkhealth markdown-tools`).
3530
- Initial release of `markdown-tools.nvim`.
3631

37-
[Unreleased]: https://github.com/magnusriga/markdown-tools.nvim/compare/v0.1.0...HEAD
32+
### Changed
33+
- Updated health checks (`:checkhealth markdown-tools`).
34+
35+
### Deprecated
36+
37+
### Removed
38+
39+
### Fixed
40+
41+
### Security
42+
43+
[Unreleased]: https://github.com/magnusriga/markdown-tools.nvim/compare/v1.0.0...HEAD
44+
[1.0.0]: https://github.com/magnusriga/markdown-tools.nvim/compare/v0.1.0...v1.0.0
3845
[0.1.0]: https://github.com/magnusriga/markdown-tools.nvim/releases/tag/v0.1.0

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# markdown-tools.nvim
1+
# markdown-tools.nvim 🪄
22

33
[![Lua](https://img.shields.io/badge/Lua-blue.svg?style=flat-square&logo=lua)](https://www.lua.org)
44
[![License](https://img.shields.io/github/license/magnusriga/markdown-tools.nvim?style=flat-square)](LICENSE)
55

6-
> 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. ✍️
77
88
`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.
99

@@ -13,13 +13,13 @@ The markdown created, including the frontmatter, is compatible with [obsidian](h
1313

1414
## ✨ Features
1515

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.
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.
2323

2424
## ⚡️ Requirements
2525

@@ -270,7 +270,7 @@ Default keymaps are provided (see Configuration). Use them in Normal or Visual m
270270
- `<leader>mp`: Preview (if configured).
271271
- `<leader>mnt`: Create new file from template.
272272

273-
### Creating Markdown Files from Templates
273+
### Creating Markdown Files from Templates 📄
274274

275275
The `:MarkdownNewTemplate` command (default keymap `<leader>mnt`) allows you to create new Markdown files based on templates stored in your configured `template_dir`.
276276

@@ -302,19 +302,19 @@ These generated values are then used in two ways:
302302
- 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]`.
303303
- 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.
304304

305-
### List Continuation
305+
### List Continuation ↩️
306306

307307
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.
308308

309-
## Status
309+
## 📈 Status
310310

311311
Stable. Contributions and suggestions are welcome.
312312

313-
## Contributing
313+
## 🤝 Contributing
314314

315315
Please see CONTRIBUTING.md or open an issue/pull request.
316316

317-
## License
317+
## 📜 License
318318

319319
Distributed under the MIT License. See `LICENSE` file for more information.
320320

0 commit comments

Comments
 (0)