Skip to main content

A creole markup converter for Holocron

Project description

pypi-version pypi-license travis-ci

Creole is a lightweight markup language, aimed at being a common markup language for wikis, enabling and simplifying the transfer of content between different wiki engines.

holocron-creole is a Creole markup converter for Holocron, an extendable static blog generator powered by the Force


Holocron uses entry-points based extension discovery mechanism, and that means it’s enough to use pip to install creole converter:

$ [sudo] pip install holocron-creole


Usage experience is similar to Markdown or reStructuredText builtin converters.

  1. Ensure that creole extension is enabled in your _config.yml:

         - markdown
         - restructuredtext
         - creole                # inserted line
         - index
         - feed
         - sitemap
         - tags
  2. Create posts and/or pages with .creole extension. Similar to builtin converters, a meta information header could be places on the top of *.creole files.

    tags: [jedi, thoughts, any-custom-tag]
    = Jedis in Real World =
    Jedi is ...
  3. Creole converter supports code syntax highlighting feature. It could be turned on/off by editing the following option:

          syntax_highlight: true

    When it’s turned on, the <<code>> macros is available for using. Example:

    <<code ext=".py">>
        def add(x, y):
            return x + y

Why GPL?

Despite the fact Holocron is distributed under BSD license, holocron-creole is licensed under GPLv3. The reason is that the project depends on python-creole library, and it’s distributed under GPLv3. That means we have no choice but to use GPL.

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

holocron-creole-1.0.0.tar.gz (19.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page