From 18e1ee44d8a0f5e449dfe4b5b6569801fd341a29 Mon Sep 17 00:00:00 2001 From: Leilei332 Date: Fri, 13 Sep 2024 02:31:13 +0800 Subject: [PATCH] Move contents of config tab to readme tab in markdown plugin (#8595) --- plugins/tiddlywiki/markdown/config.tid | 70 ------------------------ plugins/tiddlywiki/markdown/plugin.info | 2 +- plugins/tiddlywiki/markdown/readme.tid | 69 +++++++++++++++++++++++ plugins/tiddlywiki/markdown/settings.tid | 2 +- 4 files changed, 71 insertions(+), 72 deletions(-) delete mode 100755 plugins/tiddlywiki/markdown/config.tid diff --git a/plugins/tiddlywiki/markdown/config.tid b/plugins/tiddlywiki/markdown/config.tid deleted file mode 100755 index 1438d3fa6..000000000 --- a/plugins/tiddlywiki/markdown/config.tid +++ /dev/null @@ -1,70 +0,0 @@ -title: $:/plugins/tiddlywiki/markdown/config - -! Plugin Configuration - -

~WikiText Pragma

- -The value of [[renderWikiTextPragma|$:/config/markdown/renderWikiTextPragma]] has been carefully tuned to properly integrate markdown with ~TiddlyWiki. Changing this setting may produce unexpected results, but the inclusion of the following parser rules should be fine: - -; image -: embed images using ~TiddlyWiki's image syntax: - -

- -``` -[img[An explanatory tooltip|TiddlerTitle]] - -[img width=23 class="tc-image" [https://tiddlywiki.com/fractalveg.jpg]] -``` -

- -; prettylink -: create links the ~TiddlyWiki way: - -

- -``` -[[TiddlerTitle]] - -[[Displayed Link Title|Tiddler Title]] - -[[TW5|https://tiddlywiki.com/]] -``` -

- -; prettyextlink -: create external links using the following syntax: - -

- -``` -[ext[Open file|index.html]] - -[ext[Open file|../README.md]] -``` -

- -; wikilink -: auto-link ~CamelCase titles - -; syslink -: auto-link system tiddlers - -

Typographical Replacements

- -When [[typographer|$:/config/markdown/typographer]] is enabled, markdown-it will provide these typographical replacements: - -``` -(c) (C) → © -(tm) (TM) → ™ -(r) (R) → ® -+- → ± -... → … -?.... → ?.. -!.... → !.. -????? → ??? -!!!!! → !!! -,, → , --- → – ---- → — -``` \ No newline at end of file diff --git a/plugins/tiddlywiki/markdown/plugin.info b/plugins/tiddlywiki/markdown/plugin.info index 1288ad068..37211a69e 100755 --- a/plugins/tiddlywiki/markdown/plugin.info +++ b/plugins/tiddlywiki/markdown/plugin.info @@ -2,6 +2,6 @@ "title": "$:/plugins/tiddlywiki/markdown", "name": "Markdown", "description": "Markdown parser based on markdown-it", - "list": "readme config settings syntax license", + "list": "readme settings syntax license", "stability": "STABILITY_2_STABLE" } diff --git a/plugins/tiddlywiki/markdown/readme.tid b/plugins/tiddlywiki/markdown/readme.tid index 1859fd36e..f924ddec8 100755 --- a/plugins/tiddlywiki/markdown/readme.tid +++ b/plugins/tiddlywiki/markdown/readme.tid @@ -29,4 +29,73 @@ var md = $tw.Wiki.parsers["text/markdown"].prototype.md; md.use(plugin1) .use(plugin2, opts, ...); +``` + +! Plugin Configuration + +

~WikiText Pragma

+ +The value of [[renderWikiTextPragma|$:/config/markdown/renderWikiTextPragma]] has been carefully tuned to properly integrate markdown with ~TiddlyWiki. Changing this setting may produce unexpected results, but the inclusion of the following parser rules should be fine: + +; image +: embed images using ~TiddlyWiki's image syntax: + +

+ +``` +[img[An explanatory tooltip|TiddlerTitle]] + +[img width=23 class="tc-image" [https://tiddlywiki.com/fractalveg.jpg]] +``` +

+ +; prettylink +: create links the ~TiddlyWiki way: + +

+ +``` +[[TiddlerTitle]] + +[[Displayed Link Title|Tiddler Title]] + +[[TW5|https://tiddlywiki.com/]] +``` +

+ +; prettyextlink +: create external links using the following syntax: + +

+ +``` +[ext[Open file|index.html]] + +[ext[Open file|../README.md]] +``` +

+ +; wikilink +: auto-link ~CamelCase titles + +; syslink +: auto-link system tiddlers + +

Typographical Replacements

+ +When [[typographer|$:/config/markdown/typographer]] is enabled, markdown-it will provide these typographical replacements: + +``` +(c) (C) → © +(tm) (TM) → ™ +(r) (R) → ® ++- → ± +... → … +?.... → ?.. +!.... → !.. +????? → ??? +!!!!! → !!! +,, → , +-- → – +--- → — ``` \ No newline at end of file diff --git a/plugins/tiddlywiki/markdown/settings.tid b/plugins/tiddlywiki/markdown/settings.tid index 54207fa10..85f419466 100644 --- a/plugins/tiddlywiki/markdown/settings.tid +++ b/plugins/tiddlywiki/markdown/settings.tid @@ -2,7 +2,7 @@ title: $:/plugins/tiddlywiki/markdown/settings tags: $:/tags/ControlPanel/SettingsTab caption: Markdown -These settings let you customise the behaviour of Markdown. See [[plugin|$:/plugins/tiddlywiki/markdown]] readme and config tab for more information. +These settings let you customise the behaviour of Markdown. See [[plugin|$:/plugins/tiddlywiki/markdown]] readme tab for more information. ''IMPORTANT:'' You must reload your wiki for changes to take effect.