README file from
GithubignoreMD
ignoreMD adds a hover formatting toolbar for Markdown headings, emphasis, lists, links, and code.
Features
- Shows a compact Md button while editing a Markdown file.
- Opens a formatting panel when the pointer hovers over the button.
- Applies common formats without requiring users to type Markdown syntax.
- Supports headings, bold, italic, highlight, quote, unordered lists, ordered lists, task lists, inline code, code blocks, and links.
- Runs locally without telemetry, network calls, or background tasks.
How to use
- Open a Markdown file in editing mode.
- Move the pointer over the Md button near the active line or selection.
- Select a format from the toolbar.
Install manually
- Download the release assets
main.js,manifest.json, andstyles.css. - Create this folder in your vault:
.obsidian/plugins/ignoremd/. - Copy the release assets into that folder.
- Reload the app.
- Enable ignoreMD in Settings -> Community plugins.
Development
Install dependencies:
npm install
Run a development build in watch mode:
npm run dev
Run a production build:
npm run build
Run lint checks:
npm run lint
Release checklist
- Update
manifest.jsonwith the next SemVer version. - Update
versions.jsonif the minimum supported app version changes. - Run
npm run build. - Create a GitHub release whose tag exactly matches the version in
manifest.json. - Attach
manifest.json,main.js, andstyles.cssas individual release assets.
Community plugin entry
Use this entry when submitting to the community plugin list:
{
"id": "ignoremd",
"name": "ignoreMD",
"author": "zhanpeng329-arch",
"description": "Adds a hover formatting toolbar for Markdown headings, emphasis, lists, links, and code.",
"repo": "zhanpeng329-arch/obsidian-CodeIndentation"
}
License
This project is licensed under the terms in LICENSE.