# Intro
A [TiddlyWeb](http://tiddlyweb.com/) plugin to render markdown
syntax wikitext to HTML using the
[Python Markdown](https://github.com/waylan/Python-Markdown) library.
# Features
If `markdown.wiki_link_base` is set in
[instance](http://tiddlyweb.tiddlyspace.com/instance) config, then
TiddlyWeb oriented features are turned on (see below),
otherwise the text is treated as straight Markdown.
By default some extensions are included:
* `fenced_code`: http://pythonhosted.org/Markdown/extensions/fenced_code_blocks.html
* `def_list`: http://pythonhosted.org/Markdown/extensions/definition_lists.html
* `foootnotes`: http://pythonhosted.org/Markdown/extensions/footnotes.html
* `headerid`: http://pythonhosted.org/Markdown/extensions/header_id.html
The TiddlyWeb features add the following. If
[TiddlySpace](http://tiddlyspace.com) is available, then @space
additions are availble.
* `wikilinks`: CamelCase and CamelCase@space
* `spacelinks`: @space
* `freelinks`: [[some page]] and [[some page]]@space
* `labeled freelinks`: [[target|some page]] and [[target|some page]]@space
* `transclusion`: see below
Wikilinks and freelinks will be prefixed by `wiki_link_base`.
Set it to '' (emptry string) to activate the features without any prefix.
Transclusion uses the following syntax:
```
{{tiddler title}}
```
That will include tiddler with the given title from the
current context (recipe or bag) of the transcluding tiddler.
If in a TiddlySpace environment then interspace transclusion
is possible:
```
{{tiddler title}}@spacename
```
To use this renderer on Tiddlers which have a type of
`text/x-markdown` adjust
[tiddlywebconfig.py](http://tiddlyweb.tiddlyspace.com/tiddlywebconfig.py)
to include:
```
'wikitext.type_render_map' :{
'text/x-markdown': 'tiddlywebplugins.markdown'
}
```
If you want all text tiddlers to be rendered as markdown,
then set
```
'wikitext.default_renderer': 'tiddlywebplugins.markdown'
```
# Installation
Available from [PyPi](https://pypi.python.org/pypi/tiddlywebplugins.markdown),
install with [pip](https://pypi.python.org/pypi/pip):
```
pip install -U tiddlywebplugins.markdown
```
# Other
Copyright 2009, 2013 Chris Dent <cdent@peemore.com>
Licensed under the same terms as TiddlyWeb
http://tiddlyweb.com/
A [TiddlyWeb](http://tiddlyweb.com/) plugin to render markdown
syntax wikitext to HTML using the
[Python Markdown](https://github.com/waylan/Python-Markdown) library.
# Features
If `markdown.wiki_link_base` is set in
[instance](http://tiddlyweb.tiddlyspace.com/instance) config, then
TiddlyWeb oriented features are turned on (see below),
otherwise the text is treated as straight Markdown.
By default some extensions are included:
* `fenced_code`: http://pythonhosted.org/Markdown/extensions/fenced_code_blocks.html
* `def_list`: http://pythonhosted.org/Markdown/extensions/definition_lists.html
* `foootnotes`: http://pythonhosted.org/Markdown/extensions/footnotes.html
* `headerid`: http://pythonhosted.org/Markdown/extensions/header_id.html
The TiddlyWeb features add the following. If
[TiddlySpace](http://tiddlyspace.com) is available, then @space
additions are availble.
* `wikilinks`: CamelCase and CamelCase@space
* `spacelinks`: @space
* `freelinks`: [[some page]] and [[some page]]@space
* `labeled freelinks`: [[target|some page]] and [[target|some page]]@space
* `transclusion`: see below
Wikilinks and freelinks will be prefixed by `wiki_link_base`.
Set it to '' (emptry string) to activate the features without any prefix.
Transclusion uses the following syntax:
```
{{tiddler title}}
```
That will include tiddler with the given title from the
current context (recipe or bag) of the transcluding tiddler.
If in a TiddlySpace environment then interspace transclusion
is possible:
```
{{tiddler title}}@spacename
```
To use this renderer on Tiddlers which have a type of
`text/x-markdown` adjust
[tiddlywebconfig.py](http://tiddlyweb.tiddlyspace.com/tiddlywebconfig.py)
to include:
```
'wikitext.type_render_map' :{
'text/x-markdown': 'tiddlywebplugins.markdown'
}
```
If you want all text tiddlers to be rendered as markdown,
then set
```
'wikitext.default_renderer': 'tiddlywebplugins.markdown'
```
# Installation
Available from [PyPi](https://pypi.python.org/pypi/tiddlywebplugins.markdown),
install with [pip](https://pypi.python.org/pypi/pip):
```
pip install -U tiddlywebplugins.markdown
```
# Other
Copyright 2009, 2013 Chris Dent <cdent@peemore.com>
Licensed under the same terms as TiddlyWeb
http://tiddlyweb.com/
Release files for tiddlywebplugins.markdown 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tiddlywebplugins.markdown-1.0.2.tar.gz | 17.3 kB | Details |
Release files / tiddlywebplugins.markdown-1.0.2.tar.gz
| Download URL | tiddlywebplugins.markdown-1.0.2.tar.gz |
|---|---|
| Size | 17.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1fcba1f22aaa87029a4e67511f5dd8155c71f43dbe500f944096359e37328068
|
|
BLAKE2b-256 checksum How to use checksums |
8310903a825751faf338e50f591eca84b1832bc9e7497c4cc7a4079d5c77e616
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
