
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:
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
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
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).
Configure your scheming schema markdown fields with markdown_editor or fluent_markdown_editor presets
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:
- Update the version number in the
setup.py file. See PEP 440 for how to c