Extension Markdown Editor


Extension Basics

Title
Markdown Editor
Name
ckanext-markdown_editor
Type
Public extension
Description
CKEditor5 based markdown editor form snippets for ckanext-scheming
CKAN versions
Download-Url (zip)
Last commit
2 years ago (2023-08-14 09:05:49)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

Tests

ckanext-markdown_editor

CKEditor5 based markdown editor form snippets for ckanext-scheming

Requirements

Using the form snippets requires ckanext-scheming

Compatibility with core CKAN versions:

CKAN version Compatible?
2.6 and earlier not tested
2.7 not tested
2.8 not tested
2.9 yes

Installation

To install ckanext-markdown_editor:

  1. Activate your CKAN virtual environment, for example:

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

  2. Clone the source and install it on the virtualenv

    git clone https://github.com//ckanext-markdown_editor.git cd ckanext-markdown_editor pip install -e . pip install -r requirements.txt

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

  4. Configure your scheming schema markdown fields with markdown_editor or fluent_markdown_editor presets

  5. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Config settings

None at present

Developer installation

To install ckanext-markdown_editor for development, activate your CKAN virtualenv and do:

git clone https://github.com//ckanext-markdown_editor.git
cd ckanext-markdown_editor
python setup.py develop
pip install -r dev-requirements.txt

Tests

To run the tests, do:

pytest --ckan-ini=test.ini

Releasing a new version of ckanext-markdown_editor

If ckanext-markdown_editor should be available on PyPI you can follow these steps to publish a new version:

  1. Update the version number in the setup.py file. See PEP 440 for how to c
Version
Version release date
(not set)
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

To install ckanext-markdown_editor:

  1. Activate your CKAN virtual environment, for example:

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

  2. Clone the source and install it on the virtualenv

    git clone https://github.com//ckanext-markdown_editor.git cd ckanext-markdown_editor pip install -e . pip install -r requirements.txt

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

4

Plugins to configure (ckan.ini)
markdown_editor
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions