mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2025-09-01 18:38:02 +00:00
Allow Markdown dialect to be configured
This commit is contained in:
@@ -1,13 +1,34 @@
|
||||
title: HelloThere
|
||||
|
||||
This is a demo of TiddlyWiki5 incorporating a plugin for the [[markdown-js|https://github.com/evilstreak/markdown-js]] Markdown parser from Dominic Baggott.
|
||||
This is a demo of TiddlyWiki5 incorporating a plugin for the [[markdown-js|https://github.com/evilstreak/markdown-js]] Markdown parser from Dominic Baggott. The MarkdownExample tiddler below is written in Markdown.
|
||||
|
||||
The MarkdownExample tiddler below is written in Markdown. Create wiki links with the usual Markdown link syntax targeting `#` and the target tiddler title:
|
||||
! Installation
|
||||
|
||||
To add the plugin to your own TiddlyWiki5, just drag this link to the browser window:
|
||||
|
||||
[[$:/plugins/tiddlywiki/markdown]]
|
||||
|
||||
! Markdown Dialects
|
||||
|
||||
By default the markdown parser recognises the original dialect of Markdown [[as described by John Gruber|http://daringfireball.net/projects/markdown/]]. An extended dialect called "Maruku" is also included that provides table support and other advanced features. The syntax extensions are modelled on those of [[PHP Markdown Extra|https://michelf.ca/projects/php-markdown/extra/]].
|
||||
|
||||
The configuration tiddler [[$:/config/markdown/dialect]] determines which dialect is used:
|
||||
|
||||
|!Dialect |!Description |
|
||||
|Gruber |Standard Markdown |
|
||||
|Maruku |Extended Maruku Markdown |
|
||||
|
||||
|
||||
! Creating ~WikiLinks
|
||||
|
||||
Create wiki links with the usual Markdown link syntax targeting `#` and the target tiddler title:
|
||||
|
||||
```
|
||||
[link text](#TiddlerTitle)
|
||||
```
|
||||
|
||||
! Images
|
||||
|
||||
Markdown image syntax can be used to reference images by tiddler title or an external URI. For example:
|
||||
|
||||
```
|
||||
@@ -15,8 +36,3 @@ Markdown image syntax can be used to reference images by tiddler title or an ext
|
||||
|
||||

|
||||
```
|
||||
|
||||
To add the plugin to your own TiddlyWiki5, just drag this link to the browser window:
|
||||
|
||||
[[$:/plugins/tiddlywiki/markdown]]
|
||||
|
||||
|
Reference in New Issue
Block a user