Pelican Mini Wiki: A Plugin for Pelican

Pelican Mini Wiki allows you to add a minimal wiki to any Pelican theme and website.

NOTE: still under development, will not currently work or be useful.

Installation

This plugin can be installed via:

python -m pip install pelican-mini-wiki

Usage

Instructions coming soon. Configuration settings are available below.

# pelicanconf.py

...
# REQUIRED SETTINGS
MINI_WIKI = True            # Enables the plugin.
MINI_WIKI_PATH  ='wiki'     # Path to wiki files, relative to `content/` directory.
# RECOMMENDED SETTINGS
PAGE_PATHS = ['pages', MINI_WIKI_PATH]      # Sets paths to look in for `pages` type content.
PATH_METADATA = '(?P<path_no_ext>.*)\..*'   # Strips the file extension from the `path` variable.
PAGE_URL = '{path_no_ext}/'                 # Replaces the stripped file extension for the URL with a forward slash.
PAGE_SAVE_AS = '{path_no_ext}.html'         # Replaces the stripped file extension for saving.
...

Contributing

Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on existing issues.

To start contributing to this plugin, review the Contributing to Pelican documentation, beginning with the Contributing Code section.

License

This project is licensed under the MIT license.