mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-10 20:09:57 +00:00
Move contents of config tab to readme tab in markdown plugin (#8595)
This commit is contained in:
parent
fbf619b006
commit
18e1ee44d8
@ -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) → ®
|
||||
+- → ±
|
||||
... → …
|
||||
?.... → ?..
|
||||
!.... → !..
|
||||
????? → ???
|
||||
!!!!! → !!!
|
||||
,, → ,
|
||||
-- → –
|
||||
--- → —
|
||||
```
|
@ -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"
|
||||
}
|
||||
|
@ -29,4 +29,73 @@ var md = $tw.Wiki.parsers["text/markdown"].prototype.md;
|
||||
|
||||
md.use(plugin1)
|
||||
.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) → ®
|
||||
+- → ±
|
||||
... → …
|
||||
?.... → ?..
|
||||
!.... → !..
|
||||
????? → ???
|
||||
!!!!! → !!!
|
||||
,, → ,
|
||||
-- → –
|
||||
--- → —
|
||||
```
|
@ -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.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user