ckanext-markdown_view

a CKAN extension creating previews for markdown files

Requirements

Purpose

Notes:

Compatibility with core CKAN versions:

CKAN version	Compatible?
2.9 and arlier	not tested
2.10	yes
2.11	yes

• "yes"
• "not tested" - I can't think of a reason why it wouldn't work
• "not yet" - there is an intention to get it working
• "no"

Installation

To install the extension:

1. Activate your CKAN virtual environment, for example:

. /usr/lib/ckan/default/bin/activate

2. Use pip to install package

pip install ckanext-markdown_view

3. Add markdown_view to the ckan.plugins setting in your CKAN    config file (by default the config file is located at    /etc/ckan/default/ckan.ini).

4. Restart CKAN. For example, if you've deployed CKAN with Apache on Ubuntu:

sudo service apache2 reload

Config settings

You can set the default formats to preselected for upload by setting the formats,

CKANINI__CKANEXT__MARKDOWN__FORMATS = 'text/markdown'

else it will react to the listed formats by default

Highlight View

Each resource can be rendered by highlighting some markdown passage. The markdown content to highlight must be passed as post to the /highlight url, for example:

curl -X POST 'https://<ckan_url>/dataset/<dataset_d>/resource/<res_id>/highlight' -F highlight="<markdown code to highlight>"