The Markdown Syntax Suggestion extension for VS Code streamlines your writing process. This extension saves you time and ensures consistent formatting, making your Markdown documents clear and readable.
Simply type a forward slash (/) and get instant suggestions for the desired Markdown syntax. Choose your intent from the list and hit enter to effortlessly apply the formatting.
Supported Markdown Syntax
- Headings (h1-h5)
- Bold Text
- Italic Text
- Bold & Italic Text
- Strikethrough
- Blockquote (Single & Multi-Paragraph)
- Nested Blockquote
- Inline Code
- Code Block
- Unordered List
- Ordered List
- Image
- Link
- URL/Email Address
- Reference Link
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
Include if your extension adds any VS Code settings through the contributes.configuration
extension point.
For example:
This extension contributes the following settings:
myExtension.enable
: Enable/disable this extension.myExtension.thing
: Set toblah
to do something.
Calling out known issues can help limit users opening duplicate issues against your extension.
Users appreciate release notes as you update your extension.
Initial release of ...
Fixed issue #.
Added features X, Y, and Z.
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\
on macOS orCtrl+\
on Windows and Linux). - Toggle preview (
Shift+Cmd+V
on macOS orShift+Ctrl+V
on Windows and Linux). - Press
Ctrl+Space
(Windows, Linux, macOS) to see a list of Markdown snippets.
Enjoy!