https://github.com/sapegin/vscode-mini-markdown

✍🏼 A minimalist kit for comfortable Markdown writing: commands, hotkeys, autocomplete…
https://github.com/sapegin/vscode-mini-markdown

markdown vscode vscode-extension

Last synced: 10 months ago
JSON representation

✍🏼 A minimalist kit for comfortable Markdown writing: commands, hotkeys, autocomplete…

• Host: GitHub
• URL: https://github.com/sapegin/vscode-mini-markdown
• Owner: sapegin
• License: mit
• Created: 2024-07-18T07:34:31.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-02T12:48:44.000Z (about 1 year ago)
• Last Synced: 2025-03-25T02:16:02.894Z (10 months ago)
• Topics: markdown, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=sapegin.mini-markdown
• Size: 665 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Changelog: Changelog.md
  • Contributing: Contributing.md
  • License: License.md

Awesome Lists containing this project

README

          
# Mini Markdown ✍🏼

A minimalist kit for comfortable Markdown writing: commands, hotkeys, autocomplete…

**[Install from Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=sapegin.mini-markdown)**

[![Washing your code. A book on clean code for frontend developers](https://sapegin.me/images/washing-code-github.jpg)](https://sapegin.me/book/)

![Mini Markdown](screenshots/screenshot.png)

## Features

- Very minimal and fast.

- Commands to add **bold**, _italic_, and tables.

- Hotkeys to add **bold**, and _italic_.

- Autocomplete of list items.

- Code style matches Prettier formatting.

- Doesn’t pollute the editor with too many commands and hotkeys.

## Commands

You can either run this commands from the Command Palette (Cmd+Shift+P on a Mac, or Ctrl+Shift+P on Windows), or use hotkeys.

| Description | Name | Default Mac | Default Windows |

| --- | --- | --- | --- |

| Toggle emphasis (italic) | `miniMarkdown.toggleEmphasis` | Cmd+B | Ctrl+B |

| Toggle strong emphasis (bold) | `miniMarkdown.toggleStrongEmphasis` | Cmd+I | Ctrl+I |

| Insert a table | `miniMarkdown.insertTable` |  |  |

**Tip:** To insert a link in Markdown, copy the URL to the clipboard, select the text you want to link, and paste.

## Settings

You can [redefine the keybindings](https://code.visualstudio.com/docs/getstarted/keybindings) for the commands above.

## Changelog

The changelog can be found on the [Changelog.md](./Changelog.md) file.

## How is it different from other extensions?

Most Markdown extensions are bloated with commands and hotkeys I’d never need. In Mini Markdown I added only commands that I either use very often (like bold or italic), or can never remember the correct syntax (like tables). Other tools (like list autocomplete) make the writing comfortable.

Overall, I try to match the UX of the [Bear app](https://bear.app), which has, in my opinion, one of the best Markdown editors.

## You may also like

Check out my other Visual Studio Code extensions:

- [Just Blame](https://marketplace.visualstudio.com/items?itemName=sapegin.just-blame): Git Blame annotations, inspired by JetBrains editors

- [Emoji Console Log](https://marketplace.visualstudio.com/items?itemName=sapegin.emoji-console-log): insert `console.log()` statements with a random emoji

- [New File Now](https://marketplace.visualstudio.com/items?itemName=sapegin.new-file-now): create new files from the command palette

- [Notebox](https://marketplace.visualstudio.com/items?itemName=sapegin.notebox): take quick notes in the bottom panel

- [Todo Tomorrow](https://marketplace.visualstudio.com/items?itemName=sapegin.todo-tomorrow): highlight `TODO`, `HACK`, `FIXME`, etc. comments

- [Reveal in Ghostty](https://marketplace.visualstudio.com/items?itemName=sapegin.reveal-in-ghostty): reveal current project or folder in Ghostty

- [Reveal in Nimble Commander](https://marketplace.visualstudio.com/items?itemName=sapegin.reveal-in-nimble-commander): reveal current project or folder in Nimble Commander

- [Squirrelsong Light Theme](https://marketplace.visualstudio.com/items?itemName=sapegin.Theme-SquirrelsongLight): low contrast non-distracting light theme for web developers

- [Squirrelsong Dark Theme](https://marketplace.visualstudio.com/items?itemName=sapegin.Theme-SquirrelsongDark): low contrast non-distracting dark theme for web developers

## Sponsoring

This software has been developed with lots of coffee, buy me one more cup to keep it going.



## Contributing

Bug fixes are welcome, but not new features. Please take a moment to review the [contributing guidelines](Contributing.md).

## Authors and license

[Artem Sapegin](https://sapegin.me), and [contributors](https://github.com/sapegin/vscode-mini-markdown/graphs/contributors).

MIT License, see the included [License.md](License.md) file.