Skip to content

bhyvex/tiddlywebplugins.twikified

 
 

Repository files navigation

Build Status

About

Provides an interface between TiddlyWeb and the node.js wikifier for TiddlyWiki text. When a request is made to render a tiddler with TiddlyWiki text it is passed on to a node.js module for processing. It then returns the result back to the client that requested it.

Requirements

  • Python
  • make
  • A working TiddlyWeb instance to test against
  • py.test to run the tests.

Contributing

setup.py is used to package up the plugin and install it.

Plugin code lives in the tiddlywebplugins directory.

Tests live in the test directory.

Usage

make test runs the tests. Currently there is just the one that ensures the plugin can be imported.

make install installs the plugin as a package on your system (you may need sudo for this.)

To set this plugin as the default renderer for all tiddlers, add the following to tiddlywebconfig.py:

'wikitext.default_renderer': 'tiddlywebplugins.twikified'

For more details on usage run:

pydoc tiddlywebplugins/twikified.render.py

Credits

@cdent is the original author of twikified. I've just packaged it up a bit.

See Also

See the accompanying node module

About

Interface between TiddlyWeb and the node.js wikifier for TiddlyWiki text.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 97.5%
  • Makefile 2.5%