markdown-inline-preview-vscode
A VS Code extension for improving the display of markdown directly in the editor. This makes markdown editing more pleasant as you don't need to be switching between the editor and preview as much, and it hides a lot of clutter.
https://github.com/domdomegg/markdown-inline-preview-vscode/assets/4953590/112da46d-214b-4d2c-8f13-c269c8d040cd
Tweaks made include:
- Making headings larger
- Hiding bold, italic, strikethrough and code formatting characters
- Disabling coloring of bold text and headings
Usage
Install from the VS Code Marketplace or Open VSX Registry
Recommended `.vscode/settings.json`
{
"[markdown]": {
"editor.quickSuggestions": {
"other": false,
"comments": false,
"strings": false
},
"editor.fontFamily": "Fira Sans",
"editor.wrappingStrategy": "advanced",
"editor.fontSize": 13,
"editor.lineHeight": 1.5,
"editor.cursorBlinking": "phase",
"editor.lineNumbers": "off",
"editor.indentSize": "tabSize",
"editor.tabSize": 6,
"editor.insertSpaces": false,
"editor.autoClosingBrackets": "never",
"editor.bracketPairColorization.enabled": false,
"editor.matchBrackets": "never",
"editor.guides.indentation": false,
"editor.padding.top": 20
},
"editor.tokenColorCustomizations": {
"[Default Dark Modern]": {
"textMateRules": [
{
"scope": "punctuation.definition.list.begin.markdown",
"settings": {
"foreground": "#777",
}
},
]
}
}
}
Contributing
Pull requests are welcomed on GitHub! To get started:
- Install Git and Node.js
- Clone the repository
- Install dependencies with
npm install
- Build with
npm run build
Run the extension locally with the 'Run and Debug' preset in VS Code.
Releases
Versions follow the semantic versioning spec.
To release:
- Use
npm version <major | minor | patch> to bump the version
- Run
git push --follow-tags to push with tags
- Wait for GitHub Actions to publish to the NPM registry.
