Skip to main content

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/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tiddlywebplugins.markdown-1.0.4.tar.gz (19.0 kB view details)

Uploaded Source

File details

Details for the file tiddlywebplugins.markdown-1.0.4.tar.gz.

File metadata

File hashes

Hashes for tiddlywebplugins.markdown-1.0.4.tar.gz
Algorithm Hash digest
SHA256 7b593263ce51700fe0a5fd6dae8d54c05c1f8eaae26f36b863d10d8a447cf8d7
MD5 67431d65c7626cc53c3b38f199cb60fd
BLAKE2b-256 413281be768937e3cdd911d79ecb5778e20d7ea322d15b9cfa2d9b9455576be2

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page