A set of APIs and utilities for working with BitBucket wikis. These aim to address a number of deficiencies present in the BitBucket wiki system, namely:
- #2659 Show all of the page on a wiki
- #6195 Allow project wikis to be browsable by tag or branch
- #122 Wiki Search
And eventually allow wikis to be rendered to static HTML for hosting off site particularly in light of issue 6195 that prevents easy browsing of past versions of a wiki.
Currently contains the following modules:
A simple API for representing wikis
An API providing support for populating a wiki data model from disk plus parsing and feature extraction support.
An API providing support for checking a wiki for common issues such as broken links.
A command line utility for checking a wiki for common issues such as broken links. This is a simple command line wrapper around the wiki-checker-api module
An API providing support for rendering a wiki into static HTML.
The following additional features are planned for the tools:
- Add wiki-render module(s) which can be used to render a wiki into HTML for static deployments
- Include the ability to render versioned content
- Include the ability to create site maps and TOC pages
- Use creole-parser for Creole (https://github.com/mrico/creole-parser)
- Use Markdown4j for Markdown (https://code.google.com/p/markdown4j/)
- Use textile4j for Textile (http://sourceforge.net/projects/textile4j/)
- Use JRst for RestructedText (http://maven-site.nuiton.org/jrst/en/index.html)
- Support for detecting links in ReStructedText and Textile formats
- Add wiki-indexer module(s) which can be used to index a wiki for full text search with Lucene
Licensed under the MIT License