Metadata-Version: 2.4
Name: ckanext-markdown_view
Version: 1.0.1
Summary: An extension for a markdown preview
Home-page: https://github.com/Mat-O-Lab/ckanext-markdown_view
Author: Thomas Hanke
Author-email: thomas.hanke@iwm.fraunhofer.de
License: AGPL
Keywords: CKAN Markdown
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: summary

[![Tests](https://github.com/Mat-O-Lab/ckanext-markdown_view/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Mat-O-Lab/ckanext-markdown_view/actions/workflows/test.yml)

# 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:
```bash
. /usr/lib/ckan/default/bin/activate
```
2. Use pip to install package
```bash
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:
```bash
sudo service apache2 reload
```

## Config settings

You can set the default formats to preselected for upload by setting the formats,
```bash
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:
```bash
curl -X POST 'https://<ckan_url>/dataset/<dataset_d>/resource/<res_id>/highlight' -F highlight="<markdown code to highlight>"
```


