Markdown rendering for TiddlyWeb
Project description
# 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-hypernode.com/pypi/tiddlywebplugins.markdown),
install with [pip](https://pypi-hypernode.com/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-hypernode.com/pypi/tiddlywebplugins.markdown),
install with [pip](https://pypi-hypernode.com/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 history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file tiddlywebplugins.markdown-1.0.3.tar.gz.
File metadata
- Download URL: tiddlywebplugins.markdown-1.0.3.tar.gz
- Upload date:
- Size: 18.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bd032c5152b882619d913773539e3f719d70e365889a2a434b5b7daae1f660c8 |
|
| MD5 | e175234fdd55d8c0c23c914d3d80118d |
|
| BLAKE2b-256 | b1fabe08130b8eac8460c4ae14efcbbe2b002c3591803ecb5e76f8e34744787d |
