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

Installation

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

Usage experience is similar to Markdown or reStructuredText builtin converters.

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

    ext:
      enabled:
         - 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:

    ext:
       creole:
          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
    <</code>>
    

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


Release history Release notifications

This version
History Node

1.0.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
holocron-creole-1.0.0.tar.gz (19.2 kB) Copy SHA256 hash SHA256 Source None Oct 27, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page