TiddlyWiki5/plugins/tiddlywiki/markdown/usage.tid

title: $:/plugins/tiddlywiki/markdown/usage
type: text/vnd.tiddlywiki

! 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:

```
![alt text](/path/to/img.jpg "Title")

![alt text](Motovun Jack.jpg "Title")
```
Improve plugin readmes Now every plugin has a short, introductory readme tiddler that is shown in the online plugin library. 2015-03-19 10:53:45 +00:00			`title: $:/plugins/tiddlywiki/markdown/usage`
Add text/vnd.tiddlywiki to system tiddlers within plugins that should be wikified (c.f. #2883) 2017-06-09 14:52:19 +00:00			`type: text/vnd.tiddlywiki`
Improve plugin readmes Now every plugin has a short, introductory readme tiddler that is shown in the online plugin library. 2015-03-19 10:53:45 +00:00
			`! 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:`

			```
			`![alt text](/path/to/img.jpg "Title")`

			`![alt text](Motovun Jack.jpg "Title")`
			```