1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-24 00:50:28 +00:00
TiddlyWiki5/plugins/tiddlywiki/markdown
Jeremy Ruston 5aa3646df5
Add plugin stability badges (#8198)
* Initial Commit

* Fix plugin library URL

* Need to set plugin library location for prerelease

* Styling tweaks

* Docs

* Add tests that the core plugins all have a valid stability field
2024-05-21 11:22:39 +01:00
..
editor-operations Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
EditorToolbar Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
files Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
images Parameterise core icons (#7413) 2023-05-06 12:08:46 +01:00
KeyboardShortcuts Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
config.multids Markdown Plugin: Default to recognising TiddlyWiki-format links 2023-02-24 09:51:45 +00:00
config.tid Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
docs_type_markdown.tid Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
markdown-it-katex.js Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
markdown-it-tiddlywiki.js Update widget name policy (#7510) 2023-06-14 09:55:16 +01:00
new-markdown.tid Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
plugin.info Add plugin stability badges (#8198) 2024-05-21 11:22:39 +01:00
readme.tid Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
styles.tid Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
syntax.tid Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
wrapper.js Add wikiparser.js dependency (#7330) 2023-03-05 10:34:41 +00:00

title: $:/plugins/tiddlywiki/markdown/readme

This plugin provides Markdown support via the [[markdown-it|https://github.com/markdown-it/markdown-it]] parser and its associated plugins:

* markdown-it-deflist
* markdown-it-footnote
* markdown-it-ins
* markdown-it-mark
* markdown-it-sub
* markdown-it-sup

!! Compatibility Notes

* <p>A tab character in Markdown has a size of four spaces. Configure the tab size of your code editor accordingly. For example, if you use <$text text="CodeMirror"/>, it is recommended that you set $:/config/codemirror/indentUnit and $:/config/codemirror/tabSize to `4` to avoid inconsistent indentations.</p>
* <p>HTML blocks are ultimately parsed by the <$text text=WikiText/> parser: //an opening tag followed by a blank line will activate block-level parsing for its content//. When working with tags designed to contain literal content, such as `<pre>` and `<style>` tags, refrain from adding blank lines after the opening tags.</p>
* <p>You must terminate a table with either a blank line or another block-level structure.</p>
* <p>`latex-parser` in $:/config/markdown/renderWikiTextPragma is no longer required and will be ignored.</p>
* <p>Config option `linkNewWindow` is removed.</p>

!! Extending the Parser

You can extend the parser by loading additional markdown-it plugins this way:

```js
var plugin1 = require(...);
var plugin2 = require(...);

var md = $tw.Wiki.parsers["text/markdown"].prototype.md;

md.use(plugin1)
  .use(plugin2, opts, ...);
```