mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-13 05:19:58 +00:00
Code Issues Releases Wiki Activity

Move contents of config tab to readme tab in markdown plugin (#8595)

Browse Source
This commit is contained in:
Leilei332 2024-09-13 02:31:13 +08:00 committed by GitHub
parent fbf619b006
commit 18e1ee44d8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 71 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
plugins/tiddlywiki/markdown/config.tid
View File

@ -1,70 +0,0 @@
title: $:/plugins/tiddlywiki/markdown/config
! Plugin Configuration
<h2 style="margin-top:1.5em">~WikiText Pragma</h2>
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:
<p style="margin-left:1em">
```
[img[An explanatory tooltip|TiddlerTitle]]
[img width=23 class="tc-image" [https://tiddlywiki.com/fractalveg.jpg]]
```
</p>
; prettylink
: create links the ~TiddlyWiki way:
<p style="margin-left:1em">
```
[[TiddlerTitle]]
[[Displayed Link Title|Tiddler Title]]
[[TW5|https://tiddlywiki.com/]]
```
</p>
; prettyextlink
: create external links using the following syntax:
<p style="margin-left:1em">
```
[ext[Open file|index.html]]
[ext[Open file|../README.md]]
```
</p>
; wikilink
: auto-link ~CamelCase titles
; syslink
: auto-link system tiddlers
<h2 style="margin-top:1.5em">Typographical Replacements</h2>
When [[typographer|$:/config/markdown/typographer]] is enabled, markdown-it will provide these typographical replacements:
```
(c) (C) → ©
(tm) (TM) → ™
(r) (R) → ®
+- → ±
... → …
?.... → ?..
!.... → !..
????? → ???
!!!!! → !!!
,, → ,
-- → &ndash;
--- → &mdash;
```

2
plugins/tiddlywiki/markdown/plugin.info
View File

@ -2,6 +2,6 @@
"title": "$:/plugins/tiddlywiki/markdown", "title": "$:/plugins/tiddlywiki/markdown",
"name": "Markdown", "name": "Markdown",
"description": "Markdown parser based on markdown-it", "description": "Markdown parser based on markdown-it",
"list": "readme config settings syntax license", "list": "readme settings syntax license",
"stability": "STABILITY_2_STABLE" "stability": "STABILITY_2_STABLE"
} }

69
plugins/tiddlywiki/markdown/readme.tid
View File

@ -29,4 +29,73 @@ var md = $tw.Wiki.parsers["text/markdown"].prototype.md;
md.use(plugin1) md.use(plugin1)
.use(plugin2, opts, ...); .use(plugin2, opts, ...);
```
! Plugin Configuration
<h2 style="margin-top:1.5em">~WikiText Pragma</h2>
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:
<p style="margin-left:1em">
```
[img[An explanatory tooltip|TiddlerTitle]]
[img width=23 class="tc-image" [https://tiddlywiki.com/fractalveg.jpg]]
```
</p>
; prettylink
: create links the ~TiddlyWiki way:
<p style="margin-left:1em">
```
[[TiddlerTitle]]
[[Displayed Link Title|Tiddler Title]]
[[TW5|https://tiddlywiki.com/]]
```
</p>
; prettyextlink
: create external links using the following syntax:
<p style="margin-left:1em">
```
[ext[Open file|index.html]]
[ext[Open file|../README.md]]
```
</p>
; wikilink
: auto-link ~CamelCase titles
; syslink
: auto-link system tiddlers
<h2 style="margin-top:1.5em">Typographical Replacements</h2>
When [[typographer|$:/config/markdown/typographer]] is enabled, markdown-it will provide these typographical replacements:
```
(c) (C) → ©
(tm) (TM) → ™
(r) (R) → ®
+- → ±
... → …
?.... → ?..
!.... → !..
????? → ???
!!!!! → !!!
,, → ,
-- → &ndash;
--- → &mdash;
``` ```

2
plugins/tiddlywiki/markdown/settings.tid
View File

@ -2,7 +2,7 @@ title: $:/plugins/tiddlywiki/markdown/settings
tags: $:/tags/ControlPanel/SettingsTab tags: $:/tags/ControlPanel/SettingsTab
caption: Markdown 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. ''IMPORTANT:'' You must reload your wiki for changes to take effect.