Admonition support
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 61.6k
- Forks
- 4.6k
- Avg merge
- 23h 49m
- Merged PRs (30d)
- 89
Description
Describe your feature request
I'm a big fan of Marktext and it has become my default Markdown editor.
I'm using it mostly to write documentation, which works really well.
To create user-friendly documentation, I use the full spectrum of the markdown markup.
I like to use "highlights" to make warnings/tips/... stand-out.
For this I'm using the "Admonition" markdown addition.
https://python-markdown.github.io/extensions/admonition/
It would be really great that MarkText supports this; visually or at minimum support the "indented by four spaces", which I can't seem to get working.
What problem does this feature solve? [optional]
Support visual rending of the "Admonition" markdown format.
Additional context [optional]
Have a look at some visual examples:
https://squidfunk.github.io/mkdocs-material/extensions/admonition/#note
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named. Start by locating MarkText’s Markdown rendering and editor preview path, then compare the Python-Markdown and MkDocs Material admonition examples linked in the issue. Done means the agreed admonition syntax renders visually, or the agreed four-space form is supported, with coverage for the chosen behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- electron, markdown, typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100