markdown-xblock 2.4.0__py3-none-any.whl

markdown_xblock/translations/README.txt

@@ -0,0 +1,4 @@
+Use this translations directory to provide internationalized strings for your XBlock project.
+
+For more information on how to enable translations, visit the Open edX XBlock tutorial on Internationalization:
+http://edx.readthedocs.org/projects/xblock-tutorial/en/latest/edx_platform/edx_lms.html

markdown_xblock/utils.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+"""
+Helpers functions for HTML XBlock.
+"""
+
+
+def _(text):
+    """
+    Make '_' a no-op so we can scrape strings.
+    """
+    return text

markdown_xblock-2.4.0.dist-info/METADATA

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: markdown-xblock
+Version: 2.4.0
+Summary: Markdown XBlock provides editing course content in Markdown.
+License-Expression: AGPL-3.0-only
+Project-URL: Repository, https://github.com/cleura/markdown-xblock
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Education
+Classifier: Topic :: Education :: Computer Aided Instruction (CAI)
+Classifier: Topic :: Education
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: XBlock<7,>=5.2
+Requires-Dist: markdown2>=2.5.4
+Requires-Dist: Pygments>=2.0.1
+Dynamic: license-file
+
+[![PyPI version](https://badge.fury.io/py/markdown-xblock.svg)](https://pypi.python.org/pypi/markdown-xblock)
+
+# Markdown XBlock
+### Based on the [HTML XBlock by OpenCraft](https://github.com/open-craft/xblock-html)
+
+## Introduction
+This XBlock allows course authors to create and edit course content in Markdown
+and displays it as HTML.
+
+## Installation with [Tutor](https://docs.tutor.edly.io)
+You may install the markdown-xblock to your Tutor environment by adding it to the `OPENEDX_EXTRA_PIP_REQUIREMENTS` list in `config.yml`:
+```
+OPENEDX_EXTRA_PIP_REQUIREMENTS:
+- markdown-xblock==2.4.0
+```
+
+Or, if you prefer to install directly from Git:
+```
+OPENEDX_EXTRA_PIP_REQUIREMENTS:
+- git+https://github.com/cleura/markdown-xblock.git@v2.4.0
+```
+For additional information, please refer to the official [documentation](https://docs.tutor.edly.io/configuration.html#open-edx-customisation).
+
+The minimum supported Python version is 3.8.
+
+To enable this block, add `"markdown"` to the course's advanced module list. 
+The option `Markdown` will appear in the advanced components.
+
+Once you've added a new `Markdown` component to your course, you can also add custom CSS classes to the component
+by selecting `EDIT`/`Settings` and adding to the `classes` list (Note: use double quotes `" "`). Example:
+```
+["custom-css-class-1", "custom-css-class-2"]
+```
+
+The `Markdown` block uses [markdown2](https://pypi.org/project/markdown2/) to translate the content into HTML, 
+by default the following extras are included:
+
+* "code-friendly"
+* "fenced-code-blocks"
+* "footnotes"
+* "tables"
+* "use-file-vars"
+
+## Configuration
+It is possible to configure more
+[extras](https://github.com/trentm/python-markdown2/wiki/Extras), by
+adding to the extras list under `"markdown"` key in `XBLOCK_SETTINGS`
+in your [Tutor plugin](https://docs.tutor.edly.io/plugins/index.html) that patches `openedx-common-settings`
+
+By default, the `safe_mode` for `markdown2` library is enabled and set
+to `replace`, which means that writing inline HTML is not allowed and
+if written, all tags will be replaced with `[HTML_REMOVED]`. You can
+also set `safe_mode` to `escape`, which only replaces `<`, `>` and `&`
+with `&lt;`, `&gt;` and `&amp;`. To disable safe mode altogether and
+allow inline HTML, you'll need to set `safe_mode` to `False` or `None`
+in `XBLOCK_SETTINGS`. Please note that setting `safe_mode` to the
+empty string (`''`) *also* disables safe mode.
+
+Example (YAML plugin):
+```
+name: markdown
+version: 1.0.0
+patches:
+  openedx-common-settings: |
+    XBLOCK_SETTINGS["markdown"] = {
+        "extras": [
+            "code-friendly",
+            "fenced-code-blocks",
+            "footnotes",
+            "tables",
+            "header-ids",
+            "metadata",
+            "pyshell",
+            "smarty-pants",
+            "strike",
+            "target-blank-links",
+            "use-file-vars",
+            "wiki-tables",
+            "tag-friendly"
+        ],
+        "safe_mode": "escape"
+    }
+```
+
+## Usage notes
+
+### Images
+
+To include images in your markdown content, use the standard
+Markdown inline image syntax. Your course images will normally live in
+the `static/images` directory, relative to the root of your course, so
+you would include an image like this:
+
+```markdown
+![alt text for example image](/static/images/example.png)
+```
+
+The XBlock will then mangle your image reference into a static asset
+reference.
+
+### Links
+
+If Markdown XBlock content contains links to another course, and your
+platform is configured with the XBlock's safe mode enabled, a link
+like
+
+```markdown
+[link text](https://example.com/courses/course-v1:Org+Class+Version/about)
+```
+
+will, when rendered, turn its `+` characters into whitespace. That
+isn't actually wrong, because both `+` and the `%20` escape sequence
+in URLs are meant to represent whitespace, yet Open edX uses the `+`
+character to mean something *other* than whitespace, and that's a bit
+of a problem.
+
+To preserve Open edX course URL references, please explicitly encode
+the `+` character as `%2B`, like so:
+
+```markdown
+[link text](https://example.com/courses/course-v1:Org%2BClass%2BVersion/about)
+```
+
+## Development
+If you'd like to develop on this repo in `Tutor`, follow the steps described in the
+[documentation](https://docs.tutor.edly.io/tutorials/edx-platform.html#working-on-edx-platform-python-dependencies).
+
+
+### Running tests
+The testing framework is built on [tox](https://tox.readthedocs.io/en/latest/). After installing tox, you can run `tox` from your Git checkout of this repository.
+
+To throw away and rebuild the testing environment, run:
+```shell
+$ tox -r
+```
+For running PEP-8 checks only:
+```shell
+$ tox -e flake8
+```

markdown_xblock-2.4.0.dist-info/RECORD

@@ -0,0 +1,83 @@
+markdown_xblock/__init__.py,sha256=KNjg9I4FtdeY2UxhZIoh53XibeWUnwYNL1BkWabr_7U,77
+markdown_xblock/html.py,sha256=6gvPhhaUn20XeMm2zVMMx4PqrtJKJ5SSgKnLYXJUqEs,12100
+markdown_xblock/utils.py,sha256=RVReO_jZS3dcpTGxoQC-PvWRBDbQ-YKHwKlzTuEYc74,161
+markdown_xblock/public/plugins/codemirror/LICENSE,sha256=KY0Q4kvNeDsVD8B81krRdfUITzYVug58V5qpXFXyLqw,1106
+markdown_xblock/public/plugins/codemirror/plugin.min.js,sha256=xoFpVV7E-kbpN_4m2SgegJUYbuCV_eo3RvCNeOyysRQ,1081
+markdown_xblock/public/plugins/codemirror/source.html,sha256=6wUnWYBui1Cj4O4yTYduiO8DLBl_HpDrb5kOgQH7c_I,8161
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/addon/dialog/dialog.css,sha256=tv28xIBqFyPQbhDTSVqBuDl7pOc0DyZq7YfOpE9fRT8,502
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/addon/dialog/dialog.js,sha256=bjSa7a11x-n-S3E8fAHoS0GfVhcEvnpyDcRU5LHpbRs,4872
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/addon/display/fullscreen.css,sha256=SpuaNYgDjBMdeyjrjtsC-U5fpSDpftPNv7oO8HQvG7w,116
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/addon/display/fullscreen.js,sha256=gEWmEEzRvSCXzJ-6Ev6-i5uP6jkbqm1ymNkojIZPtEY,1494
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/addon/edit/matchbrackets.js,sha256=f5DzhjgME3OpiO20lDwLZ0dvvru2dSmHhHT2xDnsVuI,5268
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/addon/search/search.js,sha256=Lh331NyTpeZG03sa5r-AbHC_QppbKWCN6X7dimiBBcc,6740
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/addon/search/searchcursor.js,sha256=U1c9HnUZtMc_ta_5i3Lc-oko7HZbBNF76fFgLEWarlc,7720
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/addon/selection/active-line.js,sha256=VuI8lnpv_1ZfmOIwnoVE1NkmrOcqnsQqbGbxEmLT6-0,2442
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/lib/codemirror.css,sha256=6P_eLpXvQN1PLfmbvP5mv-44x9whXy_jOB--5S0Tnh4,8166
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/lib/codemirror.js,sha256=_WHGi4Loz6n9EEHmhaFh0m5EZ5vrpsy5IoafeYUcaHs,332949
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/mode/css/css.js,sha256=lxoRHQ-Zd9mFCb9y4R7VPFrUPU1eP7zkKuCl8pZ15SI,31664
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/mode/htmlmixed/htmlmixed.js,sha256=uSEF0q2GkruHE8A8X8ULRorXMk8tiVVG9HSOVbNWdTw,5008
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/mode/javascript/javascript.js,sha256=5j8xoMOQTap8hUPiK6YCSMleGi3tusuiNv9oct7-2s8,26092
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/mode/markdown/markdown.js,sha256=pQFcvKwAC_kBa1j-a01A_2J5P8fRbls3BICZTUGKdVs,32795
+markdown_xblock/public/plugins/codemirror/codemirror-4.8/mode/xml/xml.js,sha256=U0MS26K12wx9Iw96w2JbLS-4gH_kmNUc8ROc_lqJFrI,12375
+markdown_xblock/public/plugins/codemirror/langs/en.js,sha256=bXUr7sEWV40tGd0-2Zwt0ezuprZbXaw0tTaYqW96qLQ,216
+markdown_xblock/public/plugins/codesample/plugin.min.js,sha256=7993qSD03R-Uvnw-KcRo86kHq_f9UwKb8RfxirWxXHo,19335
+markdown_xblock/public/plugins/codesample/css/prism.css,sha256=0hSZhUD5EpVF2ruC96f_pbr3n_c3LnZm0EyOzizoLLY,2400
+markdown_xblock/public/plugins/codesample/js/prism.js,sha256=m04DvojM-1XAZgwYMZCfjWF3Z_TQS4O2AYhe4VKoIOo,23415
+markdown_xblock/public/plugins/image/plugin.min.js,sha256=4GIHWE4vCqSorV93FV2YiUCIdnrnIoplHAqUzjMmHjc,16029
+markdown_xblock/public/plugins/link/plugin.min.js,sha256=86YfjZ7PReaDnfdNF1GcbMKXhDLLxi7OGoFFwILhf8g,8919
+markdown_xblock/public/plugins/lists/plugin.min.js,sha256=ZwLtALOlBcaShJHNh720EIqJh0sP6cVIXd5jt-DbzY8,14256
+markdown_xblock/public/plugins/textcolor/plugin.min.js,sha256=7l9Srq4-KRRpTHU7qPbsduw3x-8m4npkZ_5oxyEi8Wg,4924
+markdown_xblock/public/skin/content.inline.min.css,sha256=_Cn1DpPCFJEEqEAjpSQq0CU4Uy52rVbXOO90dUGqwY4,971
+markdown_xblock/public/skin/content.min.css,sha256=pLjFeT9_UEWac96JMvl4SIBFmkBhJ4NYNEiFW1KpvdE,1857
+markdown_xblock/public/skin/skin.ie7.min.css,sha256=kbk3wd6z2ji6CNot0NGoUADaw3ux4BDuzFL31Mw8qSU,27691
+markdown_xblock/public/skin/skin.json,sha256=njdbp9L5WoxSyBR7XR-3Hkv7SqAPRM7-ds2zCM-oXlA,1567
+markdown_xblock/public/skin/skin.min.css,sha256=9WOLTcIij9RBnyfKtzum95_pHdWkObtCnYCiIL_JXPI,27802
+markdown_xblock/public/skin/fonts/icomoon-small.eot,sha256=h3dZmp50qDuEr4RSzFt6f4HMlgKp1q7y2fnXm65XWMU,8344
+markdown_xblock/public/skin/fonts/icomoon-small.svg,sha256=o9AqkVAi8Xgc8UfSPhQ4rgpESxp8iO0ncNJi_gr3vaw,25886
+markdown_xblock/public/skin/fonts/icomoon-small.ttf,sha256=hs6U_zQ0v6aR0VWqlc_bolKo3pIbvXnmXKH-2X3TdLE,8160
+markdown_xblock/public/skin/fonts/icomoon-small.woff,sha256=_TfHBt2-99VYaB528xDqNEKllDOMYa5o0ARPwv521-w,8336
+markdown_xblock/public/skin/fonts/icomoon.eot,sha256=boeQxq8euv8UHB7a82ZVx6gIve4WU-wVwm48q3Pvb2k,8268
+markdown_xblock/public/skin/fonts/icomoon.svg,sha256=nVYuKPvFq6U9on-o9CDc-kjdlkRub-P4IjJZ7XUUpKs,26077
+markdown_xblock/public/skin/fonts/icomoon.ttf,sha256=rn4MDU1J8TpcSXtfAt0-SBEsvhLZw9JbWj6C3TxPuCE,8104
+markdown_xblock/public/skin/fonts/icomoon.woff,sha256=Oby4W6AGcSGdv9sPBJi78QTjPEz3NdRW3QS9jqusiFk,8400
+markdown_xblock/public/skin/fonts/readme.md,sha256=jeRQiB9w6FREzMutGxKmNBGUrK-SXOGJUJYcBWoO48w,67
+markdown_xblock/public/skin/img/anchor.gif,sha256=KGFmb9EH0njURJlwYVE20G1_dGvpuxkHLPnI8w5WXh4,53
+markdown_xblock/public/skin/img/loader.gif,sha256=wdhs6SigsOxfwanXrbDNbQsg6WqrguxXcy2pFVinrp8,2569
+markdown_xblock/public/skin/img/object.gif,sha256=5qFeUrxKF7CFBzuo3r1HCOrWrj1MvrOIDGXLevxIl3c,152
+markdown_xblock/public/skin/img/trans.gif,sha256=nPAg18O7p_WrEM2lSqvvk0-QbU-aOs-Z6efcbJhXljU,43
+markdown_xblock/public/skin/img/wline.gif,sha256=aLpoPGfUzAtzKS6q15ahAqoPvooeV8vwMK94WkhDRMc,46
+markdown_xblock/static/css/html.css,sha256=rlhUdjEapdDJYZV65VOJ9hlnuEB92ybsPUV4FeP6eCw,284
+markdown_xblock/static/css/pygments.css,sha256=PmKzioRmCm23Vvrtj10JY78YJUsVviz3VokyUP05kb0,5053
+markdown_xblock/static/html/lms.html,sha256=1aY-lHLT9Dz-SNDMidy0EJ847oNvmaggkNFqDTTQa8Q,120
+markdown_xblock/static/html/studio.html,sha256=MMBgv4USDL_eANgEoV2Ldi-gbmqk6sDYoA0p7UNH_Ps,999
+markdown_xblock/static/js/html.js,sha256=mxqBd-vDUUWIBAGIKZVgrmH-W2cKK44vdKAsig7C7rY,8529
+markdown_xblock/static/js/tinymce/tinymce.js,sha256=1P7NGS2G6M8bZmgMJoxeTpgqGfNzdJzIR85XaybeG1w,911420
+markdown_xblock/static/js/tinymce/tinymce.min.js,sha256=VxTotcSTbUiN0bEVdS3ZqZCZGmyJIyKz5ZmzGkXESi4,351170
+markdown_xblock/static/js/tinymce/themes/modern/theme.min.js,sha256=anBIRgD7IlAHxtghhSOSjcbwrF9vksBkrTYOYZpKzPg,131421
+markdown_xblock/translations/README.txt,sha256=qtC0wGX7nUhZUW3j-VkjbXogEegR5Lm1gcF4fwhYFh4,295
+markdown_xblock-2.4.0.dist-info/licenses/LICENSE,sha256=4S14VpdCb50-mprHwxk4fLGBV611UfrV4kWMIUggnhY,35136
+releasenotes/notes/add-default-css-for-tables-3a53e02e8a350253.yaml,sha256=BMC1cyANM6V9eld90W4hhfM_c1QUFDIROkMKoppPg4w,131
+releasenotes/notes/add_public_view-d24763b7941dc2b0.yaml,sha256=t7B2dDQQrgkoqOq3iuvNIhQkRFXQzUWEku3WRmKJZtI,76
+releasenotes/notes/custom-css-classes-7984a9c95147d39c.yaml,sha256=_3pebLJ97Lrbha2Etf59CuYLG3sHIRiY6Vx3rm54oxc,149
+releasenotes/notes/export-md-to-file-ab1528b4c28cb2f0.yaml,sha256=CDDh4emtHj3d__h6korL6dPS3KSunuldHDZMGvdG8uo,147
+releasenotes/notes/fix-course-export-b35c78a22be0c6b5.yaml,sha256=TaemEFRQRGrvTNEARV4f5850fsz_IZRYYvZNDumztkA,169
+releasenotes/notes/missing-codemirror-files-d64ccb15d0faf640.yaml,sha256=-UIZ7xzVV9f1IcQ4QWbfuyFAy7aIm6JuO2LvW0JmrV8,197
+releasenotes/notes/pypi-release-3e4d5ceb7b6e252a.yaml,sha256=cZy-4x0j2uV3W1xF1952zR0O0SWmfimhqZdGgVKe8II,190
+releasenotes/notes/python-3.12-support-dac839f8d01ac6b9.yaml,sha256=m6xccSTKfuoyCVs3dQxAKCGKbo0j5Bg3VMySRUM-oa0,52
+releasenotes/notes/refactor-ci-36abda8c15250d06.yaml,sha256=G7w-fnMsVzggnFRepBUEnt1yf75fgB3C6tTu3PUfPvc,193
+releasenotes/notes/refactor-export-import-49bbf0e8a364f139.yaml,sha256=-1hmATEbm638TCmkza0rPHFq6BYX32E8DUNPemvN9wc,240
+releasenotes/notes/remove_py35-0b265861449b1753.yaml,sha256=wRvqIZTAcixLzWXpse7bFEPNluGxvss_t3SRdjwwMCY,291
+releasenotes/notes/safe_mode_replace_escape-40fdb78ec8aa5eff.yaml,sha256=PUIaMSsOMM2mUxjVTUuctzQioB3YSuMCcngnPLCNW40,304
+releasenotes/notes/show_in_read_only_mode-3af39459d5d56b33.yaml,sha256=WGHF55AChKgKOxoi1pSEfzmlfIjig6-SG0cm6zTNEpA,293
+requirements/base.txt,sha256=ErUr1uz9winxSPiQPuhHXonovyBEpz_05hkMa-IkOiM,140
+requirements/dev.txt,sha256=jJ3NFeW9olMbnFLW2REV5MCVQx4hjt0G7Vr90ZV-v2s,36
+requirements/reno.txt,sha256=W1nF_LwFDboCBe8JAiW_-btcCON9nL0nUa5tiI6vzbk,5
+requirements/test.txt,sha256=kNU5aub4LOrOSYkw_aAmZ7d7uBadQxd6I6ZgtrbtCFA,129
+tests/__init__.py,sha256=guydM15p_AKfKpC3KbEVN2bksC9pkxpjOW8YDZhc07E,20
+tests/test_basics.py,sha256=n24wvcuP1WFL3bPcdJuoWCRxqd4mqvHwssc3tCp0Rfs,12147
+var/.placeholder,sha256=Rn0AqyAVyCUbLkKmEu8soKVWKRafCTXZsM8IOu0gUrU,108
+markdown_xblock-2.4.0.dist-info/METADATA,sha256=qzahJRsU8SWCda1ltf-B1kDQdRB_NVUz-Jf0zC8N84Y,5334
+markdown_xblock-2.4.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+markdown_xblock-2.4.0.dist-info/entry_points.txt,sha256=p8Fd0Mb3w0VfdWjRG_oJ9hODsmEjFh6blIOVhT9G7YE,54
+markdown_xblock-2.4.0.dist-info/top_level.txt,sha256=KRMMQzmf61AxYZZ72-OTmtaJ950ftJbAURoQIHtqt9g,52
+markdown_xblock-2.4.0.dist-info/RECORD,,

markdown_xblock-2.4.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

markdown_xblock-2.4.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[xblock.v1]
+markdown = markdown_xblock:MarkdownXBlock