'+ escapeHtml(title) + '
' + escapeHtml(summary) +'
\n \n\n \n \n \n\n
\n\n \n
\n\n \n
\n \n
\n \n \n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n\n\n
\n
\n
\n
\n
\n Customization¶
\nGeneral (ex. settings)¶
\nWidget¶
\nThe default widget is as seen here.
\nIf you would like to customise this; for instance, using Bootstrap v3 to implement side-by-side panes (as seen in :doc:preview animation<index>), you should override the default widget’s template by creating your own template and saving it under markdownx/widget.html in your project's TEMPLATE_DIRS.
Here is an example of the contents:
\n<div class=\"markdownx row\">\n <div class=\"col-md-6\">\n {% include 'django/forms/widgets/textarea.html' %}\n </div>\n <div class=\"col-md-6\">\n <div class=\"markdownx-preview\"></div>\n </div>\n</div>Fields¶
\nWe have ensured that MarkdownX is fully extensible and provides a high degree of flexibility in development.
\nThere are times that you may wish to Markdownify a different type of field, or utilize your own customized widget. To accommodate this, we have provided the tools to apply MarkdownX infrastructure to other fields through Widgets.
\nFor instance, to apply MarkdownX to TextField instances in your Django Admins, you can override the default widget in the Admins module in admin.py of your Django App as follows:
from django.db import models\nfrom django.contrib import admin\n\nfrom markdownx.widgets import AdminMarkdownxWidget\n\nfrom .models import MyModel\n\n\nclass MyModelAdmin(admin.ModelAdmin):\n formfield_overrides = {\n models.TextField: {'widget': AdminMarkdownxWidget},\n }\n\n\nadmin.site.register(MyModel, MyModelAdmin)Image tags¶
\nMarkdown uses ![]() tag by default to insert uploaded image file. This generates a simple (X)HTML <image> tag. If you wish to have more control and use your own HTML tags, you may create a custom form_valid() function in\nImageUploadView class, as highlighted here.
\n
Settings¶
\nYou may place any of the variables outlined in this page in your settings.py, alter their values and override default behaviours:
- \n
MARKDOWNX_MARKDOWNIFY_FUNCTION\nMARKDOWNX_MARKDOWN_EXTENSIONS\nMARKDOWNX_MARKDOWN_EXTENSION_CONFIGS\nMARKDOWNX_URLS_PATH\nMARKDOWNX_UPLOAD_URLS_PATH\nMARKDOWNX_MEDIA_PATH\nMARKDOWNX_UPLOAD_MAX_SIZE\nMARKDOWNX_UPLOAD_CONTENT_TYPES\nMARKDOWNX_SKIP_RESIZE\nMARKDOWNX_IMAGE_MAX_SIZE\nMARKDOWNX_SVG_JAVASCRIPT_PROTECTION\nMARKDOWNX_EDITOR_RESIZABLE\nMARKDOWNX_SERVER_CALL_LATENCY\n
\n
\nAttention
\nThe focus of this section is on the customisation of features controlled in the backend. Additional customisations, or to be rather more accurate, event controls are enabled in the frontend through JavaScript events. To learn more about these events, see our JavaScript documentation on events.
\n\n
MARKDOWNX_MARKDOWNIFY_FUNCTION¶
\nDefault: 'markdownx.utils.markdownify'
Markdown to HTML function. Takes an argument of type str() and returns the HTML encoded output as str().
Default function that compiles markdown using defined extensions. Using custom function can allow you to pre-process or post-process markdown text. See below for more info.
\nMARKDOWNX_MARKDOWNIFY_FUNCTION = 'markdownx.utils.markdownify'This function uses the Markdown package for trans-compilation.
\n\n
\nNote
\nThe function name must be entered as string, and the relevant package must be installed and accessible to the current interpreter such that it can later be imported as and when needed. So markdownx.utils.markdownify essentially means from markdownx.utils import markdownify.
\n
\nHint
\nThe default function (markdownx.utils.markdownify) that handles the trans-compilation of Markdown to HTML looks like this:
from markdown import markdown\n\nfrom .settings import (\n MARKDOWNX_MARKDOWN_EXTENSIONS,\n MARKDOWNX_MARKDOWN_EXTENSION_CONFIGS\n)\n\ndef markdownify(content):\n md = markdown(\n text=content,\n extensions=MARKDOWNX_MARKDOWN_EXTENSIONS,\n extension_configs=MARKDOWNX_MARKDOWN_EXTENSION_CONFIGS\n )\n return mdMARKDOWNX_MARKDOWN_EXTENSIONS¶
\nDefault: empty list()
List of str(). List of Markdown extensions that you would like to use. See available extensions in Markdown docs. For instance, the extension extra enables features such as abbreviations, footnotes, tables and so on.
We recommend you read the documentation for the Markdown package, our default Markdown trans-compiler.
\nMARKDOWNX_MARKDOWN_EXTENSIONS = [\n 'markdown.extensions.extra'\n]MARKDOWNX_MARKDOWN_EXTENSION_CONFIGS¶
\nDefault: empty dict()
Configuration object for used markdown extensions. See extension_configs in Markdown docs. Here is a general idea:
MARKDOWNX_MARKDOWN_EXTENSION_CONFIGS = {\n 'extension_name_1': {\n 'option_1': 'value_1'\n }\n}MARKDOWNX_URLS_PATH¶
\nDefault: '/markdownx/markdownify/'
Relative URL to which the Markdown text is sent to be encoded as HTML.
\nMARKDOWNX_URLS_PATH = '/markdownx/markdownify/'MARKDOWNX_UPLOAD_URLS_PATH¶
\nDefault: '/markdownx/upload/'
URL that accepts file uploads (images) through an AJAX POST request. The request response will contain markdown formatted markup containing the relative URL for the image.
MARKDOWNX_UPLOAD_URLS_PATH = '/markdownx/upload/'MARKDOWNX_MEDIA_PATH¶
\nDefault: 'markdownx/'
The path where the images will be stored in your MEDIA_ROOT directory.
MARKDOWNX_MEDIA_PATH = 'markdownx/'\n
\nTip
\nRecommended: Storing all uploaded images in a single directory would over time results in a lot files being stored in one location. This would slow down the process of saving and loading files substantially, and can in turn lead to your website becoming very slow when it comes to loading images. To address this issue, it is better to save the uploads in different directories. Here is an example of how this can be achieved:
\nfrom datetime import datetime\n\nMARKDOWNX_MEDIA_PATH = datetime.now().strftime('markdownx/%Y/%m/%d')This ensures that uploaded files are stored in a different directory on the basis of the date on which they are uploaded. So for instance; an image uploaded on the 15th of April 2017 will be stored under media/markdownx/2017/4/15/unique_name.png.
MARKDOWNX_UPLOAD_MAX_SIZE¶
\nDefault: 50 * 1024 * 1024 bytes
Maximum image size allowed in bytes: Default is 50MB, which is equal to 52,428,800 bytes.
\nMARKDOWNX_UPLOAD_MAX_SIZE = 50 * 1024 * 1024\n
\nTip
\nIt is considered a good practice to display large numbers in a meaningful way. For instance, 52,438,800 bytes is better displayed in code as = 50 * 1024 * 1024 # 50 MB in bytes instead (the comment is also important). Fellow programmers will thank you for this in the future!
MARKDOWNX_UPLOAD_CONTENT_TYPES¶
\nDefault: ['image/jpeg', 'image/png', 'image/gif', 'image/svg+xml']
Image formats that the user is permitted to upload. Enable / disable support for different image formats.
\nMARKDOWNX_UPLOAD_CONTENT_TYPES = ['image/jpeg', 'image/png', 'image/gif', 'image/svg+xml']MARKDOWNX_SKIP_RESIZE¶
\nDefault: ['image/svg+xml', 'image/gif']
Image formats that should not be resized automatically. The default value honors that resizing an SVG does not make sense and that PIL does not support GIF animation.
\nMARKDOWNX_SKIP_RESIZE = ['image/svg+xml', 'image/gif']MARKDOWNX_IMAGE_MAX_SIZE¶
\nDefault: { 'size': (500, 500), 'quality': 90 }
Different options describing final image processing; e.g. dimension and quality.
\n\n
\nNote
\nQuality restrictions do not apply to image/svg+xml formatted graphics.
Options are:
\n| Option | \nValue | \nDescription | \n
|---|---|---|
| size | \n(width,height) | \nwhen one of the dimensions is set to zero, e.g. (500, 0), the height is calculated automatically so as to keep the dimensions intact. | \n
| quality | \nint | \nimage quality from 0 (full compression) to 100 (no compression). Default: 90 | \n
| crop | \nBoolean | \nif True, the size is used to crop the image. Default: False | \n
| upscale | \nBoolean | \nif image dimensions are smaller than those defined in size, upscale to size dimensions. Default: False | \n
MARKDOWNX_IMAGE_MAX_SIZE = {\n 'size': (500, 500),\n 'quality': 90\n}MARKDOWNX_SVG_JAVASCRIPT_PROTECTION¶
\nDefault: True
SVG graphics are in essence XML files formatted in a specific way; which means that they can contain JavaScript codes. This introduces a potential front-end security vulnerability for prospective users who will see the SVG image in context; e.g. it may be employed to collect the user's IP address or other personal information.
\n\n
\nNote
\nThis type of attack is known as XSS (Cross-site Scripting) attack. See this presentation by Mario Heiderich to learn more on SVG XSS attacks. There are a number of ways to deal with this vulnerability.
\nDjango is great at security, and provides very good protection against XSS attacks (see the Django documentation for additional information) providing the CSRF protection middleware is enabled. When it comes to AJAX requests, however, CSRF protection may sometimes be disabled for various reasons.
\nAs a last resort, however, we have included an optional integrity check against JavaScript tags for SVG formatted files just in case everything else is disabled. This protection is enabled by default, and may be disabled by setting the value to False if so is desired.
MARKDOWNX_SVG_JAVASCRIPT_PROTECTION = True\n
\nImportant
\nMarkdownX does not disable CSRF protection by default, and requires the token for all AJAX request.
\nMARKDOWNX_EDITOR_RESIZABLE¶
\nDefault: True
Change the editor's height to match the height of the inner contents whilst typing.
\nMARKDOWNX_EDITOR_RESIZABLE = TrueMARKDOWNX_SERVER_CALL_LATENCY¶
\nDefault: 500 miliseconds
Latency (minimum lag) between server calls as int. Minimum allowed: 500 milliseconds.
\n
\nNote
\nWhen the value of a MarkdownX editor is changed, a call is made to the server to trans-compile Markdown into HTML. However, a minimum latency of 500 milliseconds has been imposed between the calls. This is to prevent the bombardment of the server with a huge number of HTTP requests (you don't want to DDoS your own server). This latency maintains a balance between responsiveness and protection, and is well-suited for medium traffic. Nonetheless, if your website enjoys a particularly high traffic, you may wish to alter this value slightly depending on the number of CPUs, the amount memory, and how much you are willing to compromise on responsiveness.
\nMARKDOWNX_SERVER_CALL_LATENCY = 500 # milliseconds\n
\n \n Attention
\nAny values below 500 milliseconds is silently ignored and replaced.
\n\n \n \n \n GitHub\n \n \n \n « Previous\n \n \n Next »\n \n \n
\n \n \n \n \n \n \n\n\n\n"
},
{
"path": "docs/example/index.html",
"content": "\n\n\n \n \n \n \n \n \n\n \n \n \n\n
\n\n \n
\n\n \n
\n \n
\n \n \n \n
\n Example¶
\nHave you:
\n- \n
- successfully installed MarkdownX? \n
- followed the instructions on how to get started? \n
If so, you are set for the next step. Here you can find comprehensive examples of how to use different MarkdownX\nfeatures to your advantage.
\nModel¶
\nThis is how you implement a MarkdownX field in your models. In your app/models.py:
from markdownx.models import MarkdownxField\n\nclass MyModel(models.Model):\n myfield = MarkdownxField()... and then, include the form media in the relevant template using {{ form.media }}, like so:
<form method=\"POST\" action=\"\">{% csrf_token %}\n {{ form }}\n</form>\n\n{{ form.media }}\n
\nNote
\nThe field extends Django's own TextField and is saved in the database accordingly.
\nForm¶
\nYou can also implement MarkdownX through the forms. This will be done in your app/forms.py as follows:
from markdownx.fields import MarkdownxFormField\n\nclass MyForm(forms.Form):\n myfield = MarkdownxFormField()... and then, include a form's required media in the template using {{ form.media }}:
<form method=\"POST\" action=\"\">{% csrf_token %}\n {{ form }}\n</form>\n\n{{ form.media }}Django Admin¶
\nWhen using included MarkdownxModel class in your models, just use MarkdownxModelAdmin in your app/admin.py as follows:
from django.contrib import admin\nfrom markdownx.admin import MarkdownxModelAdmin\nfrom .models import MyModel\n\nadmin.site.register(MyModel, MarkdownxModelAdmin)\n \n \n \n GitHub\n \n \n \n « Previous\n \n \n Next »\n \n \n
\n \n \n \n \n \n \n\n\n\n"
},
{
"path": "docs/getting_started/index.html",
"content": "\n\n\n \n \n \n \n \n \n\n \n \n \n\n
\n\n \n
\n\n \n
\n \n
\n \n \n \n
\n Getting Started¶
\nFirst and foremost, add markdownx to the list of INSTALLED_APPS in settings.py.
INSTALLED_APPS = (\n # [...]\n 'markdownx',\n)You may alter default behaviours by adding and changing relevant variables in your settings. See customization for additional information.
\nAdd MarkdownX URL patterns to your urls.py. You can do this using either of these methods depending on your style:
urlpatterns = [\n # [...]\n path('markdownx/', include('markdownx.urls')),\n]or alternatively:
\nfrom django.conf.urls import url, include\nfrom markdownx import urls as markdownx\n\nurlpatterns += [\n path('markdownx/', include(markdownx)),\n]and, don't forget to collect MarkdownX assets to your STATIC_ROOT. To do this, run:\n
python3 manage.py collectstatic\n \n \n \n GitHub\n \n \n \n « Previous\n \n \n Next »\n \n \n
\n \n \n \n \n \n \n\n\n\n"
},
{
"path": "docs/index.html",
"content": "\n\n\n \n \n \n \n \n \n\n \n \n \n\n
\n\n \n \n \n \n \n \n \n\n\n\n\n\n"
},
{
"path": "docs/installation/index.html",
"content": "\n\n\n \n \n \n \n \n
\n\n \n
\n \n
\n \n \n \n
\n Django MarkdownX¶
\nDjango MarkdownX is a comprehensive Markdown plugin built for Django, the renowned high-level Python web framework, with flexibility, extensibility, and ease-of-use at its core.
\nGitHub: https://github.com/neutronX/django-markdownx
\nPyPi: https://pypi.org/project/django-markdownx/
Key features¶
\n- \n
- Raw editing. \n
- Live preview. \n
- Drag & drop image uploads (automatically stored in the designated location in the Media directory). \n
- Customizable image insertion tag. \n
- Definition of maximum size for an image. \n
- Definition of acceptable image formats (PNG, JPEG, SVG). \n
- Image manipulations (compression, size reduction, cropping, upscaling). \n
- Pre- and post- text modification. \n
- Easy template customization, layout modification, and personalization. \n
- Multiple editors per page. \n
- Django Admin support. \n
Preview¶
\n![\"django-markdownx](\"https://github.com/neutronX/django-markdownx/raw/master/django-markdownx-preview.gif?raw=true\")
Acknowledgements¶
\nWe acknowledge and appreciate every contribution made towards improving Django MarkdownX, a list of which can be\nfound on our GitHub contributors page.
\n \n\n \n\n \n \n \n\n
\n\n \n
\n\n \n
\n \n
\n \n \n \n
\n Installation¶
\nUsing PIP¶
\nDjango MarkdownX may be installed directly using Python Package Index (PyPi):
\npip install django-markdownxFrom the source¶
\nShould you wish to download and install it using the source code, you can do as follows:
\n\n
\nNote
\nMake sure you have activated your virtual environment if you’re using one.
\nWe start off by downloading the source code from GitHub and navigate to the downloaded directory:
\ngit clone https://github.com/neutronX/django-markdownx.git\ncd django-markdownx/Install the package.
\npython3 setup.py install\n \n \n \n GitHub\n \n \n \n « Previous\n \n \n Next »\n \n \n
\n \n \n \n \n \n \n\n\n\n"
},
{
"path": "docs/javascript/index.html",
"content": "\n\n\n \n \n \n \n \n \n\n \n \n \n\n
\n\n \n
\n\n \n
\n \n
\n \n \n \n
\n
\n
\n
\n
\n
\n
\n JavaScript¶
\nEvents¶
\nSome MarkdownX processes trigger events that may be utilized for different purposes. To handle such events in JavaScript, you may take advantage of event listeners as exemplified below:
\n- \n
markdownx.init\nmarkdownx.update\nmarkdownx.updateError\nmarkdownx.markdownx.fileUploadBegin\nmarkdownx.fileUploadEnd\nmarkdownx.fileUploadError\n
markdownx.init¶
\nTriggered after jQuery plugin init. markdownx.init is an event that does not return a response.
JavaScript ECMA 2015+:
\nlet element = document.getElementsByClassName('markdownx');\n\nObject.keys(element).map(key =>\n\n element[key].addEventListener('markdownx.init', () => console.log(\"MarkdownX initialized.\"))\n\n);markdownx.update¶
\nTriggered when editor text is markdownified. Returns: response (string) variable containing markdownified text.
\nJavaScript ECMA 2015+:
\nlet element = document.getElementsByClassName('markdownx');\n\nObject.keys(element).map(key =>\n\n element[key].addEventListener('markdownx.update', event => console.log(event.detail))\n\n);markdownx.updateError¶
\nTriggered when a problem occurred during markdownify.
\nmarkdownx.markdownx.fileUploadBegin¶
\nTriggered when the file is posted.
\nmarkdownx.fileUploadEnd¶
\nTriggered when the file has been uploaded.
\nmarkdownx.fileUploadError¶
\nTriggered if the upload didn’t work.
\nCompatibility¶
\nWe rely on JavaScript to handle front-end events (e.g. trans-compilation of Markdown to HTML, uploading image).
\nMarkdownX's JavaScript code is written in TypeScript using Pure JavaScript and under ECMA 2016 standard.
\nCurrently, the code is trans-compiled into ECMA 5 (approved in 2011) to provide support for older browsers, specifically IE 10+. See additional detailed on browser compatibilities.
\n \n\n \n \n \n GitHub\n \n \n \n « Previous\n \n \n Next »\n \n \n
\n \n \n \n \n \n \n\n\n\n"
},
{
"path": "docs/js/theme.js",
"content": "/* sphinx_rtd_theme version 1.0.0 | MIT license */\n!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){\"undefined\"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:\"Module\"}),Object.defineProperty(n,\"__esModule\",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&\"object\"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,\"default\",{enumerable:!0,value:n}),2&e&&\"string\"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,\"a\",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p=\"\",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e=\"undefined\"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on(\"hashchange\",t.reset),n&&t.win.on(\"scroll\",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on(\"resize\",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n(\"div.wy-side-scroll:first\"),this.win=n(window),n(document).on(\"click\",\"[data-toggle='wy-nav-top']\",(function(){n(\"[data-toggle='wy-nav-shift']\").toggleClass(\"shift\"),n(\"[data-toggle='rst-versions']\").toggleClass(\"shift\")})).on(\"click\",\".wy-menu-vertical ul li a\",(function(){var t=n(this);n(\"[data-toggle='wy-nav-shift']\").removeClass(\"shift\"),n(\"[data-toggle='rst-versions']\").toggleClass(\"shift\"),e.toggleCurrent(t),e.hashChange()})).on(\"click\",\"[data-toggle='rst-current-version']\",(function(){n(\"[data-toggle='rst-versions']\").toggleClass(\"shift-up\")})),n(\"table.docutils:not(.field-list,.footnote,.citation)\").wrap(\"\"),n(\"table.docutils.footnote\").wrap(\"\"),n(\"table.docutils.citation\").wrap(\"\"),n(\".wy-menu-vertical ul\").not(\".simple\").siblings(\"a\").each((function(){var t=n(this);expand=n(''),expand.on(\"click\",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||\"#\";try{var e=$(\".wy-menu-vertical\"),t=e.find('[href=\"'+n+'\"]');if(0===t.length){var i=$('.document [id=\"'+n.substring(1)+'\"]').closest(\"div.section\");0===(t=e.find('[href=\"#'+i.attr(\"id\")+'\"]')).length&&(t=e.find('[href=\"#\"]'))}if(t.length>0){$(\".wy-menu-vertical .current\").removeClass(\"current\").attr(\"aria-expanded\",\"false\"),t.addClass(\"current\").attr(\"aria-expanded\",\"true\"),t.closest(\"li.toctree-l1\").parent().addClass(\"current\").attr(\"aria-expanded\",\"true\");for(let n=1;n<=10;n++)t.closest(\"li.toctree-l\"+n).addClass(\"current\").attr(\"aria-expanded\",\"true\");t[0].scrollIntoView()}}catch(n){console.log(\"Error expanding nav for anchor\",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one(\"hashchange\",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest(\"li\");e.siblings(\"li.current\").removeClass(\"current\").attr(\"aria-expanded\",\"false\"),e.siblings().find(\"li.current\").removeClass(\"current\").attr(\"aria-expanded\",\"false\");var t=e.find(\"> ul li\");t.length&&(t.removeClass(\"current\").attr(\"aria-expanded\",\"false\"),e.toggleClass(\"current\").attr(\"aria-expanded\",(function(n,e){return\"true\"==e?\"false\":\"true\"})))}},\"undefined\"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=[\"ms\",\"moz\",\"webkit\",\"o\"],t=0;t\n \n\n \n \n \n\n
\n\n \n
\n\n \n
\n \n
\n \n \n \n
\n License¶
\nMarkdownX is licensed under the 2-clause BSD license, and Open Source Initiative approved license.
\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:
\n- \n
- \n
Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.
\n \n - \n
Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.
\n \n
This software is provided by the copyright holders and contributors \"as is\" and\nany express or implied warranties, including, but not limited to, the implied\nwarranties of merchantability and fitness for a particular purpose are\ndisclaimed. in no event shall the copyright owner or contributors be liable for\nany direct, indirect, incidental, special, exemplary, or consequential damages\n(including, but not limited to, procurement of substitute goods or services;\nloss of use, data, or profits; or business interruption) however caused and\non any theory of liability, whether in contract, strict liability, or tort\n(including negligence or otherwise) arising in any way out of the use of this\nsoftware, even if advised of the possibility of such damage.
\n \n\n \n \n \n GitHub\n \n \n \n « Previous\n \n \n \n
\n \n \n \n \n \n \n\n\n\n"
},
{
"path": "docs/search/lunr.js",
"content": "/**\n * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9\n * Copyright (C) 2020 Oliver Nightingale\n * @license MIT\n */\n\n;(function(){\n\n/**\n * A convenience function for configuring and constructing\n * a new lunr Index.\n *\n * A lunr.Builder instance is created and the pipeline setup\n * with a trimmer, stop word filter and stemmer.\n *\n * This builder object is yielded to the configuration function\n * that is passed as a parameter, allowing the list of fields\n * and other builder parameters to be customised.\n *\n * All documents _must_ be added within the passed config function.\n *\n * @example\n * var idx = lunr(function () {\n * this.field('title')\n * this.field('body')\n * this.ref('id')\n *\n * documents.forEach(function (doc) {\n * this.add(doc)\n * }, this)\n * })\n *\n * @see {@link lunr.Builder}\n * @see {@link lunr.Pipeline}\n * @see {@link lunr.trimmer}\n * @see {@link lunr.stopWordFilter}\n * @see {@link lunr.stemmer}\n * @namespace {function} lunr\n */\nvar lunr = function (config) {\n var builder = new lunr.Builder\n\n builder.pipeline.add(\n lunr.trimmer,\n lunr.stopWordFilter,\n lunr.stemmer\n )\n\n builder.searchPipeline.add(\n lunr.stemmer\n )\n\n config.call(builder, builder)\n return builder.build()\n}\n\nlunr.version = \"2.3.9\"\n/*!\n * lunr.utils\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A namespace containing utils for the rest of the lunr library\n * @namespace lunr.utils\n */\nlunr.utils = {}\n\n/**\n * Print a warning message to the console.\n *\n * @param {String} message The message to be printed.\n * @memberOf lunr.utils\n * @function\n */\nlunr.utils.warn = (function (global) {\n /* eslint-disable no-console */\n return function (message) {\n if (global.console && console.warn) {\n console.warn(message)\n }\n }\n /* eslint-enable no-console */\n})(this)\n\n/**\n * Convert an object to a string.\n *\n * In the case of `null` and `undefined` the function returns\n * the empty string, in all other cases the result of calling\n * `toString` on the passed object is returned.\n *\n * @param {Any} obj The object to convert to a string.\n * @return {String} string representation of the passed object.\n * @memberOf lunr.utils\n */\nlunr.utils.asString = function (obj) {\n if (obj === void 0 || obj === null) {\n return \"\"\n } else {\n return obj.toString()\n }\n}\n\n/**\n * Clones an object.\n *\n * Will create a copy of an existing object such that any mutations\n * on the copy cannot affect the original.\n *\n * Only shallow objects are supported, passing a nested object to this\n * function will cause a TypeError.\n *\n * Objects with primitives, and arrays of primitives are supported.\n *\n * @param {Object} obj The object to clone.\n * @return {Object} a clone of the passed object.\n * @throws {TypeError} when a nested object is passed.\n * @memberOf Utils\n */\nlunr.utils.clone = function (obj) {\n if (obj === null || obj === undefined) {\n return obj\n }\n\n var clone = Object.create(null),\n keys = Object.keys(obj)\n\n for (var i = 0; i < keys.length; i++) {\n var key = keys[i],\n val = obj[key]\n\n if (Array.isArray(val)) {\n clone[key] = val.slice()\n continue\n }\n\n if (typeof val === 'string' ||\n typeof val === 'number' ||\n typeof val === 'boolean') {\n clone[key] = val\n continue\n }\n\n throw new TypeError(\"clone is not deep and does not support nested objects\")\n }\n\n return clone\n}\nlunr.FieldRef = function (docRef, fieldName, stringValue) {\n this.docRef = docRef\n this.fieldName = fieldName\n this._stringValue = stringValue\n}\n\nlunr.FieldRef.joiner = \"/\"\n\nlunr.FieldRef.fromString = function (s) {\n var n = s.indexOf(lunr.FieldRef.joiner)\n\n if (n === -1) {\n throw \"malformed field ref string\"\n }\n\n var fieldRef = s.slice(0, n),\n docRef = s.slice(n + 1)\n\n return new lunr.FieldRef (docRef, fieldRef, s)\n}\n\nlunr.FieldRef.prototype.toString = function () {\n if (this._stringValue == undefined) {\n this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef\n }\n\n return this._stringValue\n}\n/*!\n * lunr.Set\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A lunr set.\n *\n * @constructor\n */\nlunr.Set = function (elements) {\n this.elements = Object.create(null)\n\n if (elements) {\n this.length = elements.length\n\n for (var i = 0; i < this.length; i++) {\n this.elements[elements[i]] = true\n }\n } else {\n this.length = 0\n }\n}\n\n/**\n * A complete set that contains all elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.complete = {\n intersect: function (other) {\n return other\n },\n\n union: function () {\n return this\n },\n\n contains: function () {\n return true\n }\n}\n\n/**\n * An empty set that contains no elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.empty = {\n intersect: function () {\n return this\n },\n\n union: function (other) {\n return other\n },\n\n contains: function () {\n return false\n }\n}\n\n/**\n * Returns true if this set contains the specified object.\n *\n * @param {object} object - Object whose presence in this set is to be tested.\n * @returns {boolean} - True if this set contains the specified object.\n */\nlunr.Set.prototype.contains = function (object) {\n return !!this.elements[object]\n}\n\n/**\n * Returns a new set containing only the elements that are present in both\n * this set and the specified set.\n *\n * @param {lunr.Set} other - set to intersect with this set.\n * @returns {lunr.Set} a new set that is the intersection of this and the specified set.\n */\n\nlunr.Set.prototype.intersect = function (other) {\n var a, b, elements, intersection = []\n\n if (other === lunr.Set.complete) {\n return this\n }\n\n if (other === lunr.Set.empty) {\n return other\n }\n\n if (this.length < other.length) {\n a = this\n b = other\n } else {\n a = other\n b = this\n }\n\n elements = Object.keys(a.elements)\n\n for (var i = 0; i < elements.length; i++) {\n var element = elements[i]\n if (element in b.elements) {\n intersection.push(element)\n }\n }\n\n return new lunr.Set (intersection)\n}\n\n/**\n * Returns a new set combining the elements of this and the specified set.\n *\n * @param {lunr.Set} other - set to union with this set.\n * @return {lunr.Set} a new set that is the union of this and the specified set.\n */\n\nlunr.Set.prototype.union = function (other) {\n if (other === lunr.Set.complete) {\n return lunr.Set.complete\n }\n\n if (other === lunr.Set.empty) {\n return this\n }\n\n return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements)))\n}\n/**\n * A function to calculate the inverse document frequency for\n * a posting. This is shared between the builder and the index\n *\n * @private\n * @param {object} posting - The posting for a given term\n * @param {number} documentCount - The total number of documents.\n */\nlunr.idf = function (posting, documentCount) {\n var documentsWithTerm = 0\n\n for (var fieldName in posting) {\n if (fieldName == '_index') continue // Ignore the term index, its not a field\n documentsWithTerm += Object.keys(posting[fieldName]).length\n }\n\n var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5)\n\n return Math.log(1 + Math.abs(x))\n}\n\n/**\n * A token wraps a string representation of a token\n * as it is passed through the text processing pipeline.\n *\n * @constructor\n * @param {string} [str=''] - The string token being wrapped.\n * @param {object} [metadata={}] - Metadata associated with this token.\n */\nlunr.Token = function (str, metadata) {\n this.str = str || \"\"\n this.metadata = metadata || {}\n}\n\n/**\n * Returns the token string that is being wrapped by this object.\n *\n * @returns {string}\n */\nlunr.Token.prototype.toString = function () {\n return this.str\n}\n\n/**\n * A token update function is used when updating or optionally\n * when cloning a token.\n *\n * @callback lunr.Token~updateFunction\n * @param {string} str - The string representation of the token.\n * @param {Object} metadata - All metadata associated with this token.\n */\n\n/**\n * Applies the given function to the wrapped string token.\n *\n * @example\n * token.update(function (str, metadata) {\n * return str.toUpperCase()\n * })\n *\n * @param {lunr.Token~updateFunction} fn - A function to apply to the token string.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.update = function (fn) {\n this.str = fn(this.str, this.metadata)\n return this\n}\n\n/**\n * Creates a clone of this token. Optionally a function can be\n * applied to the cloned token.\n *\n * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.clone = function (fn) {\n fn = fn || function (s) { return s }\n return new lunr.Token (fn(this.str, this.metadata), this.metadata)\n}\n/*!\n * lunr.tokenizer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A function for splitting a string into tokens ready to be inserted into\n * the search index. Uses `lunr.tokenizer.separator` to split strings, change\n * the value of this property to change how strings are split into tokens.\n *\n * This tokenizer will convert its parameter to a string by calling `toString` and\n * then will split this string on the character in `lunr.tokenizer.separator`.\n * Arrays will have their elements converted to strings and wrapped in a lunr.Token.\n *\n * Optional metadata can be passed to the tokenizer, this metadata will be cloned and\n * added as metadata to every token that is created from the object to be tokenized.\n *\n * @static\n * @param {?(string|object|object[])} obj - The object to convert into tokens\n * @param {?object} metadata - Optional metadata to associate with every token\n * @returns {lunr.Token[]}\n * @see {@link lunr.Pipeline}\n */\nlunr.tokenizer = function (obj, metadata) {\n if (obj == null || obj == undefined) {\n return []\n }\n\n if (Array.isArray(obj)) {\n return obj.map(function (t) {\n return new lunr.Token(\n lunr.utils.asString(t).toLowerCase(),\n lunr.utils.clone(metadata)\n )\n })\n }\n\n var str = obj.toString().toLowerCase(),\n len = str.length,\n tokens = []\n\n for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) {\n var char = str.charAt(sliceEnd),\n sliceLength = sliceEnd - sliceStart\n\n if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) {\n\n if (sliceLength > 0) {\n var tokenMetadata = lunr.utils.clone(metadata) || {}\n tokenMetadata[\"position\"] = [sliceStart, sliceLength]\n tokenMetadata[\"index\"] = tokens.length\n\n tokens.push(\n new lunr.Token (\n str.slice(sliceStart, sliceEnd),\n tokenMetadata\n )\n )\n }\n\n sliceStart = sliceEnd + 1\n }\n\n }\n\n return tokens\n}\n\n/**\n * The separator used to split a string into tokens. Override this property to change the behaviour of\n * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens.\n *\n * @static\n * @see lunr.tokenizer\n */\nlunr.tokenizer.separator = /[\\s\\-]+/\n/*!\n * lunr.Pipeline\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Pipelines maintain an ordered list of functions to be applied to all\n * tokens in documents entering the search index and queries being ran against\n * the index.\n *\n * An instance of lunr.Index created with the lunr shortcut will contain a\n * pipeline with a stop word filter and an English language stemmer. Extra\n * functions can be added before or after either of these functions or these\n * default functions can be removed.\n *\n * When run the pipeline will call each function in turn, passing a token, the\n * index of that token in the original list of all tokens and finally a list of\n * all the original tokens.\n *\n * The output of functions in the pipeline will be passed to the next function\n * in the pipeline. To exclude a token from entering the index the function\n * should return undefined, the rest of the pipeline will not be called with\n * this token.\n *\n * For serialisation of pipelines to work, all functions used in an instance of\n * a pipeline should be registered with lunr.Pipeline. Registered functions can\n * then be loaded. If trying to load a serialised pipeline that uses functions\n * that are not registered an error will be thrown.\n *\n * If not planning on serialising the pipeline then registering pipeline functions\n * is not necessary.\n *\n * @constructor\n */\nlunr.Pipeline = function () {\n this._stack = []\n}\n\nlunr.Pipeline.registeredFunctions = Object.create(null)\n\n/**\n * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token\n * string as well as all known metadata. A pipeline function can mutate the token string\n * or mutate (or add) metadata for a given token.\n *\n * A pipeline function can indicate that the passed token should be discarded by returning\n * null, undefined or an empty string. This token will not be passed to any downstream pipeline\n * functions and will not be added to the index.\n *\n * Multiple tokens can be returned by returning an array of tokens. Each token will be passed\n * to any downstream pipeline functions and all will returned tokens will be added to the index.\n *\n * Any number of pipeline functions may be chained together using a lunr.Pipeline.\n *\n * @interface lunr.PipelineFunction\n * @param {lunr.Token} token - A token from the document being processed.\n * @param {number} i - The index of this token in the complete list of tokens for this document/field.\n * @param {lunr.Token[]} tokens - All tokens for this document/field.\n * @returns {(?lunr.Token|lunr.Token[])}\n */\n\n/**\n * Register a function with the pipeline.\n *\n * Functions that are used in the pipeline should be registered if the pipeline\n * needs to be serialised, or a serialised pipeline needs to be loaded.\n *\n * Registering a function does not add it to a pipeline, functions must still be\n * added to instances of the pipeline for them to be used when running a pipeline.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @param {String} label - The label to register this function with\n */\nlunr.Pipeline.registerFunction = function (fn, label) {\n if (label in this.registeredFunctions) {\n lunr.utils.warn('Overwriting existing registered function: ' + label)\n }\n\n fn.label = label\n lunr.Pipeline.registeredFunctions[fn.label] = fn\n}\n\n/**\n * Warns if the function is not registered as a Pipeline function.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @private\n */\nlunr.Pipeline.warnIfFunctionNotRegistered = function (fn) {\n var isRegistered = fn.label && (fn.label in this.registeredFunctions)\n\n if (!isRegistered) {\n lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\\n', fn)\n }\n}\n\n/**\n * Loads a previously serialised pipeline.\n *\n * All functions to be loaded must already be registered with lunr.Pipeline.\n * If any function from the serialised data has not been registered then an\n * error will be thrown.\n *\n * @param {Object} serialised - The serialised pipeline to load.\n * @returns {lunr.Pipeline}\n */\nlunr.Pipeline.load = function (serialised) {\n var pipeline = new lunr.Pipeline\n\n serialised.forEach(function (fnName) {\n var fn = lunr.Pipeline.registeredFunctions[fnName]\n\n if (fn) {\n pipeline.add(fn)\n } else {\n throw new Error('Cannot load unregistered function: ' + fnName)\n }\n })\n\n return pipeline\n}\n\n/**\n * Adds new functions to the end of the pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline.\n */\nlunr.Pipeline.prototype.add = function () {\n var fns = Array.prototype.slice.call(arguments)\n\n fns.forEach(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n this._stack.push(fn)\n }, this)\n}\n\n/**\n * Adds a single function after a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.after = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n pos = pos + 1\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Adds a single function before a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.before = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Removes a function from the pipeline.\n *\n * @param {lunr.PipelineFunction} fn The function to remove from the pipeline.\n */\nlunr.Pipeline.prototype.remove = function (fn) {\n var pos = this._stack.indexOf(fn)\n if (pos == -1) {\n return\n }\n\n this._stack.splice(pos, 1)\n}\n\n/**\n * Runs the current list of functions that make up the pipeline against the\n * passed tokens.\n *\n * @param {Array} tokens The tokens to run through the pipeline.\n * @returns {Array}\n */\nlunr.Pipeline.prototype.run = function (tokens) {\n var stackLength = this._stack.length\n\n for (var i = 0; i < stackLength; i++) {\n var fn = this._stack[i]\n var memo = []\n\n for (var j = 0; j < tokens.length; j++) {\n var result = fn(tokens[j], j, tokens)\n\n if (result === null || result === void 0 || result === '') continue\n\n if (Array.isArray(result)) {\n for (var k = 0; k < result.length; k++) {\n memo.push(result[k])\n }\n } else {\n memo.push(result)\n }\n }\n\n tokens = memo\n }\n\n return tokens\n}\n\n/**\n * Convenience method for passing a string through a pipeline and getting\n * strings out. This method takes care of wrapping the passed string in a\n * token and mapping the resulting tokens back to strings.\n *\n * @param {string} str - The string to pass through the pipeline.\n * @param {?object} metadata - Optional metadata to associate with the token\n * passed to the pipeline.\n * @returns {string[]}\n */\nlunr.Pipeline.prototype.runString = function (str, metadata) {\n var token = new lunr.Token (str, metadata)\n\n return this.run([token]).map(function (t) {\n return t.toString()\n })\n}\n\n/**\n * Resets the pipeline by removing any existing processors.\n *\n */\nlunr.Pipeline.prototype.reset = function () {\n this._stack = []\n}\n\n/**\n * Returns a representation of the pipeline ready for serialisation.\n *\n * Logs a warning if the function has not been registered.\n *\n * @returns {Array}\n */\nlunr.Pipeline.prototype.toJSON = function () {\n return this._stack.map(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n\n return fn.label\n })\n}\n/*!\n * lunr.Vector\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A vector is used to construct the vector space of documents and queries. These\n * vectors support operations to determine the similarity between two documents or\n * a document and a query.\n *\n * Normally no parameters are required for initializing a vector, but in the case of\n * loading a previously dumped vector the raw elements can be provided to the constructor.\n *\n * For performance reasons vectors are implemented with a flat array, where an elements\n * index is immediately followed by its value. E.g. [index, value, index, value]. This\n * allows the underlying array to be as sparse as possible and still offer decent\n * performance when being used for vector calculations.\n *\n * @constructor\n * @param {Number[]} [elements] - The flat list of element index and element value pairs.\n */\nlunr.Vector = function (elements) {\n this._magnitude = 0\n this.elements = elements || []\n}\n\n\n/**\n * Calculates the position within the vector to insert a given index.\n *\n * This is used internally by insert and upsert. If there are duplicate indexes then\n * the position is returned as if the value for that index were to be updated, but it\n * is the callers responsibility to check whether there is a duplicate at that index\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @returns {Number}\n */\nlunr.Vector.prototype.positionForIndex = function (index) {\n // For an empty vector the tuple can be inserted at the beginning\n if (this.elements.length == 0) {\n return 0\n }\n\n var start = 0,\n end = this.elements.length / 2,\n sliceLength = end - start,\n pivotPoint = Math.floor(sliceLength / 2),\n pivotIndex = this.elements[pivotPoint * 2]\n\n while (sliceLength > 1) {\n if (pivotIndex < index) {\n start = pivotPoint\n }\n\n if (pivotIndex > index) {\n end = pivotPoint\n }\n\n if (pivotIndex == index) {\n break\n }\n\n sliceLength = end - start\n pivotPoint = start + Math.floor(sliceLength / 2)\n pivotIndex = this.elements[pivotPoint * 2]\n }\n\n if (pivotIndex == index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex > index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex < index) {\n return (pivotPoint + 1) * 2\n }\n}\n\n/**\n * Inserts an element at an index within the vector.\n *\n * Does not allow duplicates, will throw an error if there is already an entry\n * for this index.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n */\nlunr.Vector.prototype.insert = function (insertIdx, val) {\n this.upsert(insertIdx, val, function () {\n throw \"duplicate index\"\n })\n}\n\n/**\n * Inserts or updates an existing index within the vector.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n * @param {function} fn - A function that is called for updates, the existing value and the\n * requested value are passed as arguments\n */\nlunr.Vector.prototype.upsert = function (insertIdx, val, fn) {\n this._magnitude = 0\n var position = this.positionForIndex(insertIdx)\n\n if (this.elements[position] == insertIdx) {\n this.elements[position + 1] = fn(this.elements[position + 1], val)\n } else {\n this.elements.splice(position, 0, insertIdx, val)\n }\n}\n\n/**\n * Calculates the magnitude of this vector.\n *\n * @returns {Number}\n */\nlunr.Vector.prototype.magnitude = function () {\n if (this._magnitude) return this._magnitude\n\n var sumOfSquares = 0,\n elementsLength = this.elements.length\n\n for (var i = 1; i < elementsLength; i += 2) {\n var val = this.elements[i]\n sumOfSquares += val * val\n }\n\n return this._magnitude = Math.sqrt(sumOfSquares)\n}\n\n/**\n * Calculates the dot product of this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The vector to compute the dot product with.\n * @returns {Number}\n */\nlunr.Vector.prototype.dot = function (otherVector) {\n var dotProduct = 0,\n a = this.elements, b = otherVector.elements,\n aLen = a.length, bLen = b.length,\n aVal = 0, bVal = 0,\n i = 0, j = 0\n\n while (i < aLen && j < bLen) {\n aVal = a[i], bVal = b[j]\n if (aVal < bVal) {\n i += 2\n } else if (aVal > bVal) {\n j += 2\n } else if (aVal == bVal) {\n dotProduct += a[i + 1] * b[j + 1]\n i += 2\n j += 2\n }\n }\n\n return dotProduct\n}\n\n/**\n * Calculates the similarity between this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The other vector to calculate the\n * similarity with.\n * @returns {Number}\n */\nlunr.Vector.prototype.similarity = function (otherVector) {\n return this.dot(otherVector) / this.magnitude() || 0\n}\n\n/**\n * Converts the vector to an array of the elements within the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toArray = function () {\n var output = new Array (this.elements.length / 2)\n\n for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) {\n output[j] = this.elements[i]\n }\n\n return output\n}\n\n/**\n * A JSON serializable representation of the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toJSON = function () {\n return this.elements\n}\n/* eslint-disable */\n/*!\n * lunr.stemmer\n * Copyright (C) 2020 Oliver Nightingale\n * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt\n */\n\n/**\n * lunr.stemmer is an english language stemmer, this is a JavaScript\n * implementation of the PorterStemmer taken from http://tartarus.org/~martin\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token - The string to stem\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n * @function\n */\nlunr.stemmer = (function(){\n var step2list = {\n \"ational\" : \"ate\",\n \"tional\" : \"tion\",\n \"enci\" : \"ence\",\n \"anci\" : \"ance\",\n \"izer\" : \"ize\",\n \"bli\" : \"ble\",\n \"alli\" : \"al\",\n \"entli\" : \"ent\",\n \"eli\" : \"e\",\n \"ousli\" : \"ous\",\n \"ization\" : \"ize\",\n \"ation\" : \"ate\",\n \"ator\" : \"ate\",\n \"alism\" : \"al\",\n \"iveness\" : \"ive\",\n \"fulness\" : \"ful\",\n \"ousness\" : \"ous\",\n \"aliti\" : \"al\",\n \"iviti\" : \"ive\",\n \"biliti\" : \"ble\",\n \"logi\" : \"log\"\n },\n\n step3list = {\n \"icate\" : \"ic\",\n \"ative\" : \"\",\n \"alize\" : \"al\",\n \"iciti\" : \"ic\",\n \"ical\" : \"ic\",\n \"ful\" : \"\",\n \"ness\" : \"\"\n },\n\n c = \"[^aeiou]\", // consonant\n v = \"[aeiouy]\", // vowel\n C = c + \"[^aeiouy]*\", // consonant sequence\n V = v + \"[aeiou]*\", // vowel sequence\n\n mgr0 = \"^(\" + C + \")?\" + V + C, // [C]VC... is m>0\n meq1 = \"^(\" + C + \")?\" + V + C + \"(\" + V + \")?$\", // [C]VC[V] is m=1\n mgr1 = \"^(\" + C + \")?\" + V + C + V + C, // [C]VCVC... is m>1\n s_v = \"^(\" + C + \")?\" + v; // vowel in stem\n\n var re_mgr0 = new RegExp(mgr0);\n var re_mgr1 = new RegExp(mgr1);\n var re_meq1 = new RegExp(meq1);\n var re_s_v = new RegExp(s_v);\n\n var re_1a = /^(.+?)(ss|i)es$/;\n var re2_1a = /^(.+?)([^s])s$/;\n var re_1b = /^(.+?)eed$/;\n var re2_1b = /^(.+?)(ed|ing)$/;\n var re_1b_2 = /.$/;\n var re2_1b_2 = /(at|bl|iz)$/;\n var re3_1b_2 = new RegExp(\"([^aeiouylsz])\\\\1$\");\n var re4_1b_2 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var re_1c = /^(.+?[^aeiou])y$/;\n var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;\n\n var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;\n\n var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;\n var re2_4 = /^(.+?)(s|t)(ion)$/;\n\n var re_5 = /^(.+?)e$/;\n var re_5_1 = /ll$/;\n var re3_5 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var porterStemmer = function porterStemmer(w) {\n var stem,\n suffix,\n firstch,\n re,\n re2,\n re3,\n re4;\n\n if (w.length < 3) { return w; }\n\n firstch = w.substr(0,1);\n if (firstch == \"y\") {\n w = firstch.toUpperCase() + w.substr(1);\n }\n\n // Step 1a\n re = re_1a\n re2 = re2_1a;\n\n if (re.test(w)) { w = w.replace(re,\"$1$2\"); }\n else if (re2.test(w)) { w = w.replace(re2,\"$1$2\"); }\n\n // Step 1b\n re = re_1b;\n re2 = re2_1b;\n if (re.test(w)) {\n var fp = re.exec(w);\n re = re_mgr0;\n if (re.test(fp[1])) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1];\n re2 = re_s_v;\n if (re2.test(stem)) {\n w = stem;\n re2 = re2_1b_2;\n re3 = re3_1b_2;\n re4 = re4_1b_2;\n if (re2.test(w)) { w = w + \"e\"; }\n else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,\"\"); }\n else if (re4.test(w)) { w = w + \"e\"; }\n }\n }\n\n // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)\n re = re_1c;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n w = stem + \"i\";\n }\n\n // Step 2\n re = re_2;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step2list[suffix];\n }\n }\n\n // Step 3\n re = re_3;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step3list[suffix];\n }\n }\n\n // Step 4\n re = re_4;\n re2 = re2_4;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n if (re.test(stem)) {\n w = stem;\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1] + fp[2];\n re2 = re_mgr1;\n if (re2.test(stem)) {\n w = stem;\n }\n }\n\n // Step 5\n re = re_5;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n re2 = re_meq1;\n re3 = re3_5;\n if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {\n w = stem;\n }\n }\n\n re = re_5_1;\n re2 = re_mgr1;\n if (re.test(w) && re2.test(w)) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n\n // and turn initial Y back to y\n\n if (firstch == \"y\") {\n w = firstch.toLowerCase() + w.substr(1);\n }\n\n return w;\n };\n\n return function (token) {\n return token.update(porterStemmer);\n }\n})();\n\nlunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')\n/*!\n * lunr.stopWordFilter\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.generateStopWordFilter builds a stopWordFilter function from the provided\n * list of stop words.\n *\n * The built in lunr.stopWordFilter is built using this generator and can be used\n * to generate custom stopWordFilters for applications or non English languages.\n *\n * @function\n * @param {Array} token The token to pass through the filter\n * @returns {lunr.PipelineFunction}\n * @see lunr.Pipeline\n * @see lunr.stopWordFilter\n */\nlunr.generateStopWordFilter = function (stopWords) {\n var words = stopWords.reduce(function (memo, stopWord) {\n memo[stopWord] = stopWord\n return memo\n }, {})\n\n return function (token) {\n if (token && words[token.toString()] !== token.toString()) return token\n }\n}\n\n/**\n * lunr.stopWordFilter is an English language stop word list filter, any words\n * contained in the list will not be passed through the filter.\n *\n * This is intended to be used in the Pipeline. If the token does not pass the\n * filter then undefined will be returned.\n *\n * @function\n * @implements {lunr.PipelineFunction}\n * @params {lunr.Token} token - A token to check for being a stop word.\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n */\nlunr.stopWordFilter = lunr.generateStopWordFilter([\n 'a',\n 'able',\n 'about',\n 'across',\n 'after',\n 'all',\n 'almost',\n 'also',\n 'am',\n 'among',\n 'an',\n 'and',\n 'any',\n 'are',\n 'as',\n 'at',\n 'be',\n 'because',\n 'been',\n 'but',\n 'by',\n 'can',\n 'cannot',\n 'could',\n 'dear',\n 'did',\n 'do',\n 'does',\n 'either',\n 'else',\n 'ever',\n 'every',\n 'for',\n 'from',\n 'get',\n 'got',\n 'had',\n 'has',\n 'have',\n 'he',\n 'her',\n 'hers',\n 'him',\n 'his',\n 'how',\n 'however',\n 'i',\n 'if',\n 'in',\n 'into',\n 'is',\n 'it',\n 'its',\n 'just',\n 'least',\n 'let',\n 'like',\n 'likely',\n 'may',\n 'me',\n 'might',\n 'most',\n 'must',\n 'my',\n 'neither',\n 'no',\n 'nor',\n 'not',\n 'of',\n 'off',\n 'often',\n 'on',\n 'only',\n 'or',\n 'other',\n 'our',\n 'own',\n 'rather',\n 'said',\n 'say',\n 'says',\n 'she',\n 'should',\n 'since',\n 'so',\n 'some',\n 'than',\n 'that',\n 'the',\n 'their',\n 'them',\n 'then',\n 'there',\n 'these',\n 'they',\n 'this',\n 'tis',\n 'to',\n 'too',\n 'twas',\n 'us',\n 'wants',\n 'was',\n 'we',\n 'were',\n 'what',\n 'when',\n 'where',\n 'which',\n 'while',\n 'who',\n 'whom',\n 'why',\n 'will',\n 'with',\n 'would',\n 'yet',\n 'you',\n 'your'\n])\n\nlunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')\n/*!\n * lunr.trimmer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.trimmer is a pipeline function for trimming non word\n * characters from the beginning and end of tokens before they\n * enter the index.\n *\n * This implementation may not work correctly for non latin\n * characters and should either be removed or adapted for use\n * with languages with non-latin characters.\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token The token to pass through the filter\n * @returns {lunr.Token}\n * @see lunr.Pipeline\n */\nlunr.trimmer = function (token) {\n return token.update(function (s) {\n return s.replace(/^\\W+/, '').replace(/\\W+$/, '')\n })\n}\n\nlunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')\n/*!\n * lunr.TokenSet\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A token set is used to store the unique list of all tokens\n * within an index. Token sets are also used to represent an\n * incoming query to the index, this query token set and index\n * token set are then intersected to find which tokens to look\n * up in the inverted index.\n *\n * A token set can hold multiple tokens, as in the case of the\n * index token set, or it can hold a single token as in the\n * case of a simple query token set.\n *\n * Additionally token sets are used to perform wildcard matching.\n * Leading, contained and trailing wildcards are supported, and\n * from this edit distance matching can also be provided.\n *\n * Token sets are implemented as a minimal finite state automata,\n * where both common prefixes and suffixes are shared between tokens.\n * This helps to reduce the space used for storing the token set.\n *\n * @constructor\n */\nlunr.TokenSet = function () {\n this.final = false\n this.edges = {}\n this.id = lunr.TokenSet._nextId\n lunr.TokenSet._nextId += 1\n}\n\n/**\n * Keeps track of the next, auto increment, identifier to assign\n * to a new tokenSet.\n *\n * TokenSets require a unique identifier to be correctly minimised.\n *\n * @private\n */\nlunr.TokenSet._nextId = 1\n\n/**\n * Creates a TokenSet instance from the given sorted array of words.\n *\n * @param {String[]} arr - A sorted array of strings to create the set from.\n * @returns {lunr.TokenSet}\n * @throws Will throw an error if the input array is not sorted.\n */\nlunr.TokenSet.fromArray = function (arr) {\n var builder = new lunr.TokenSet.Builder\n\n for (var i = 0, len = arr.length; i < len; i++) {\n builder.insert(arr[i])\n }\n\n builder.finish()\n return builder.root\n}\n\n/**\n * Creates a token set from a query clause.\n *\n * @private\n * @param {Object} clause - A single clause from lunr.Query.\n * @param {string} clause.term - The query clause term.\n * @param {number} [clause.editDistance] - The optional edit distance for the term.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromClause = function (clause) {\n if ('editDistance' in clause) {\n return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance)\n } else {\n return lunr.TokenSet.fromString(clause.term)\n }\n}\n\n/**\n * Creates a token set representing a single string with a specified\n * edit distance.\n *\n * Insertions, deletions, substitutions and transpositions are each\n * treated as an edit distance of 1.\n *\n * Increasing the allowed edit distance will have a dramatic impact\n * on the performance of both creating and intersecting these TokenSets.\n * It is advised to keep the edit distance less than 3.\n *\n * @param {string} str - The string to create the token set from.\n * @param {number} editDistance - The allowed edit distance to match.\n * @returns {lunr.Vector}\n */\nlunr.TokenSet.fromFuzzyString = function (str, editDistance) {\n var root = new lunr.TokenSet\n\n var stack = [{\n node: root,\n editsRemaining: editDistance,\n str: str\n }]\n\n while (stack.length) {\n var frame = stack.pop()\n\n // no edit\n if (frame.str.length > 0) {\n var char = frame.str.charAt(0),\n noEditNode\n\n if (char in frame.node.edges) {\n noEditNode = frame.node.edges[char]\n } else {\n noEditNode = new lunr.TokenSet\n frame.node.edges[char] = noEditNode\n }\n\n if (frame.str.length == 1) {\n noEditNode.final = true\n }\n\n stack.push({\n node: noEditNode,\n editsRemaining: frame.editsRemaining,\n str: frame.str.slice(1)\n })\n }\n\n if (frame.editsRemaining == 0) {\n continue\n }\n\n // insertion\n if (\"*\" in frame.node.edges) {\n var insertionNode = frame.node.edges[\"*\"]\n } else {\n var insertionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = insertionNode\n }\n\n if (frame.str.length == 0) {\n insertionNode.final = true\n }\n\n stack.push({\n node: insertionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str\n })\n\n // deletion\n // can only do a deletion if we have enough edits remaining\n // and if there are characters left to delete in the string\n if (frame.str.length > 1) {\n stack.push({\n node: frame.node,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // deletion\n // just removing the last character from the str\n if (frame.str.length == 1) {\n frame.node.final = true\n }\n\n // substitution\n // can only do a substitution if we have enough edits remaining\n // and if there are characters left to substitute\n if (frame.str.length >= 1) {\n if (\"*\" in frame.node.edges) {\n var substitutionNode = frame.node.edges[\"*\"]\n } else {\n var substitutionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = substitutionNode\n }\n\n if (frame.str.length == 1) {\n substitutionNode.final = true\n }\n\n stack.push({\n node: substitutionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // transposition\n // can only do a transposition if there are edits remaining\n // and there are enough characters to transpose\n if (frame.str.length > 1) {\n var charA = frame.str.charAt(0),\n charB = frame.str.charAt(1),\n transposeNode\n\n if (charB in frame.node.edges) {\n transposeNode = frame.node.edges[charB]\n } else {\n transposeNode = new lunr.TokenSet\n frame.node.edges[charB] = transposeNode\n }\n\n if (frame.str.length == 1) {\n transposeNode.final = true\n }\n\n stack.push({\n node: transposeNode,\n editsRemaining: frame.editsRemaining - 1,\n str: charA + frame.str.slice(2)\n })\n }\n }\n\n return root\n}\n\n/**\n * Creates a TokenSet from a string.\n *\n * The string may contain one or more wildcard characters (*)\n * that will allow wildcard matching when intersecting with\n * another TokenSet.\n *\n * @param {string} str - The string to create a TokenSet from.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromString = function (str) {\n var node = new lunr.TokenSet,\n root = node\n\n /*\n * Iterates through all characters within the passed string\n * appending a node for each character.\n *\n * When a wildcard character is found then a self\n * referencing edge is introduced to continually match\n * any number of any characters.\n */\n for (var i = 0, len = str.length; i < len; i++) {\n var char = str[i],\n final = (i == len - 1)\n\n if (char == \"*\") {\n node.edges[char] = node\n node.final = final\n\n } else {\n var next = new lunr.TokenSet\n next.final = final\n\n node.edges[char] = next\n node = next\n }\n }\n\n return root\n}\n\n/**\n * Converts this TokenSet into an array of strings\n * contained within the TokenSet.\n *\n * This is not intended to be used on a TokenSet that\n * contains wildcards, in these cases the results are\n * undefined and are likely to cause an infinite loop.\n *\n * @returns {string[]}\n */\nlunr.TokenSet.prototype.toArray = function () {\n var words = []\n\n var stack = [{\n prefix: \"\",\n node: this\n }]\n\n while (stack.length) {\n var frame = stack.pop(),\n edges = Object.keys(frame.node.edges),\n len = edges.length\n\n if (frame.node.final) {\n /* In Safari, at this point the prefix is sometimes corrupted, see:\n * https://github.com/olivernn/lunr.js/issues/279 Calling any\n * String.prototype method forces Safari to \"cast\" this string to what\n * it's supposed to be, fixing the bug. */\n frame.prefix.charAt(0)\n words.push(frame.prefix)\n }\n\n for (var i = 0; i < len; i++) {\n var edge = edges[i]\n\n stack.push({\n prefix: frame.prefix.concat(edge),\n node: frame.node.edges[edge]\n })\n }\n }\n\n return words\n}\n\n/**\n * Generates a string representation of a TokenSet.\n *\n * This is intended to allow TokenSets to be used as keys\n * in objects, largely to aid the construction and minimisation\n * of a TokenSet. As such it is not designed to be a human\n * friendly representation of the TokenSet.\n *\n * @returns {string}\n */\nlunr.TokenSet.prototype.toString = function () {\n // NOTE: Using Object.keys here as this.edges is very likely\n // to enter 'hash-mode' with many keys being added\n //\n // avoiding a for-in loop here as it leads to the function\n // being de-optimised (at least in V8). From some simple\n // benchmarks the performance is comparable, but allowing\n // V8 to optimize may mean easy performance wins in the future.\n\n if (this._str) {\n return this._str\n }\n\n var str = this.final ? '1' : '0',\n labels = Object.keys(this.edges).sort(),\n len = labels.length\n\n for (var i = 0; i < len; i++) {\n var label = labels[i],\n node = this.edges[label]\n\n str = str + label + node.id\n }\n\n return str\n}\n\n/**\n * Returns a new TokenSet that is the intersection of\n * this TokenSet and the passed TokenSet.\n *\n * This intersection will take into account any wildcards\n * contained within the TokenSet.\n *\n * @param {lunr.TokenSet} b - An other TokenSet to intersect with.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.prototype.intersect = function (b) {\n var output = new lunr.TokenSet,\n frame = undefined\n\n var stack = [{\n qNode: b,\n output: output,\n node: this\n }]\n\n while (stack.length) {\n frame = stack.pop()\n\n // NOTE: As with the #toString method, we are using\n // Object.keys and a for loop instead of a for-in loop\n // as both of these objects enter 'hash' mode, causing\n // the function to be de-optimised in V8\n var qEdges = Object.keys(frame.qNode.edges),\n qLen = qEdges.length,\n nEdges = Object.keys(frame.node.edges),\n nLen = nEdges.length\n\n for (var q = 0; q < qLen; q++) {\n var qEdge = qEdges[q]\n\n for (var n = 0; n < nLen; n++) {\n var nEdge = nEdges[n]\n\n if (nEdge == qEdge || qEdge == '*') {\n var node = frame.node.edges[nEdge],\n qNode = frame.qNode.edges[qEdge],\n final = node.final && qNode.final,\n next = undefined\n\n if (nEdge in frame.output.edges) {\n // an edge already exists for this character\n // no need to create a new node, just set the finality\n // bit unless this node is already final\n next = frame.output.edges[nEdge]\n next.final = next.final || final\n\n } else {\n // no edge exists yet, must create one\n // set the finality bit and insert it\n // into the output\n next = new lunr.TokenSet\n next.final = final\n frame.output.edges[nEdge] = next\n }\n\n stack.push({\n qNode: qNode,\n output: next,\n node: node\n })\n }\n }\n }\n }\n\n return output\n}\nlunr.TokenSet.Builder = function () {\n this.previousWord = \"\"\n this.root = new lunr.TokenSet\n this.uncheckedNodes = []\n this.minimizedNodes = {}\n}\n\nlunr.TokenSet.Builder.prototype.insert = function (word) {\n var node,\n commonPrefix = 0\n\n if (word < this.previousWord) {\n throw new Error (\"Out of order word insertion\")\n }\n\n for (var i = 0; i < word.length && i < this.previousWord.length; i++) {\n if (word[i] != this.previousWord[i]) break\n commonPrefix++\n }\n\n this.minimize(commonPrefix)\n\n if (this.uncheckedNodes.length == 0) {\n node = this.root\n } else {\n node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child\n }\n\n for (var i = commonPrefix; i < word.length; i++) {\n var nextNode = new lunr.TokenSet,\n char = word[i]\n\n node.edges[char] = nextNode\n\n this.uncheckedNodes.push({\n parent: node,\n char: char,\n child: nextNode\n })\n\n node = nextNode\n }\n\n node.final = true\n this.previousWord = word\n}\n\nlunr.TokenSet.Builder.prototype.finish = function () {\n this.minimize(0)\n}\n\nlunr.TokenSet.Builder.prototype.minimize = function (downTo) {\n for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) {\n var node = this.uncheckedNodes[i],\n childKey = node.child.toString()\n\n if (childKey in this.minimizedNodes) {\n node.parent.edges[node.char] = this.minimizedNodes[childKey]\n } else {\n // Cache the key for this node since\n // we know it can't change anymore\n node.child._str = childKey\n\n this.minimizedNodes[childKey] = node.child\n }\n\n this.uncheckedNodes.pop()\n }\n}\n/*!\n * lunr.Index\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * An index contains the built index of all documents and provides a query interface\n * to the index.\n *\n * Usually instances of lunr.Index will not be created using this constructor, instead\n * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be\n * used to load previously built and serialized indexes.\n *\n * @constructor\n * @param {Object} attrs - The attributes of the built search index.\n * @param {Object} attrs.invertedIndex - An index of term/field to document reference.\n * @param {Object' + noResultsText + '
');\n }\n}\n\nfunction doSearch () {\n var query = document.getElementById('mkdocs-search-query').value;\n if (query.length > min_search_length) {\n if (!window.Worker) {\n displayResults(search(query));\n } else {\n searchWorker.postMessage({query: query});\n }\n } else {\n // Clear results for short queries\n displayResults([]);\n }\n}\n\nfunction initSearch () {\n var search_input = document.getElementById('mkdocs-search-query');\n if (search_input) {\n search_input.addEventListener(\"keyup\", doSearch);\n }\n var term = getSearchTermFromLocation();\n if (term) {\n search_input.value = term;\n doSearch();\n }\n}\n\nfunction onWorkerMessage (e) {\n if (e.data.allowSearch) {\n initSearch();\n } else if (e.data.results) {\n var results = e.data.results;\n displayResults(results);\n } else if (e.data.config) {\n min_search_length = e.data.config.min_search_length-1;\n }\n}\n\nif (!window.Worker) {\n console.log('Web Worker API not supported');\n // load index in main thread\n $.getScript(joinUrl(base_url, \"search/worker.js\")).done(function () {\n console.log('Loaded worker');\n init();\n window.postMessage = function (msg) {\n onWorkerMessage({data: msg});\n };\n }).fail(function (jqxhr, settings, exception) {\n console.error('Could not load worker.js');\n });\n} else {\n // Wrap search in a web worker\n var searchWorker = new Worker(joinUrl(base_url, \"search/worker.js\"));\n searchWorker.postMessage({init: true});\n searchWorker.onmessage = onWorkerMessage;\n}\n" }, { "path": "docs/search/search_index.json", "content": "{\"config\":{\"indexing\":\"full\",\"lang\":[\"en\"],\"min_search_length\":3,\"prebuild_index\":false,\"separator\":\"[\\\\s\\\\-]+\"},\"docs\":[{\"location\":\"\",\"text\":\"Django MarkdownX \\u00b6 Django MarkdownX is a comprehensive Markdown plugin built for Django , the renowned high-level Python web framework, with flexibility, extensibility, and ease-of-use at its core. GitHub: https://github.com/neutronX/django-markdownx PyPi: https://pypi.org/project/django-markdownx/ Key features \\u00b6 Raw editing. Live preview. Drag & drop image uploads (automatically stored in the designated location in the Media directory). Customizable image insertion tag. Definition of maximum size for an image. Definition of acceptable image formats (PNG, JPEG, SVG). Image manipulations (compression, size reduction, cropping, upscaling). Pre- and post- text modification. Easy template customization, layout modification, and personalization. Multiple editors per page. Django Admin support. Preview \\u00b6 Acknowledgements \\u00b6 We acknowledge and appreciate every contribution made towards improving Django MarkdownX , a list of which can be found on our GitHub contributors page .\",\"title\":\"Django MarkdownX\"},{\"location\":\"#django-markdownx\",\"text\":\"Django MarkdownX is a comprehensive Markdown plugin built for Django , the renowned high-level Python web framework, with flexibility, extensibility, and ease-of-use at its core. GitHub: https://github.com/neutronX/django-markdownx PyPi: https://pypi.org/project/django-markdownx/\",\"title\":\"Django MarkdownX\"},{\"location\":\"#key-features\",\"text\":\"Raw editing. Live preview. Drag & drop image uploads (automatically stored in the designated location in the Media directory). Customizable image insertion tag. Definition of maximum size for an image. Definition of acceptable image formats (PNG, JPEG, SVG). Image manipulations (compression, size reduction, cropping, upscaling). Pre- and post- text modification. Easy template customization, layout modification, and personalization. Multiple editors per page. Django Admin support.\",\"title\":\"Key features\"},{\"location\":\"#preview\",\"text\":\"\",\"title\":\"Preview\"},{\"location\":\"#acknowledgements\",\"text\":\"We acknowledge and appreciate every contribution made towards improving Django MarkdownX , a list of which can be found on our GitHub contributors page .\",\"title\":\"Acknowledgements\"},{\"location\":\"contributions/\",\"text\":\"Contributions \\u00b6 We welcome and encourage contributions of all nature; from pointing out an error or a potential problem, to translations, to feature requests, and pull requests. We have a implemented a fully comprehensive developers' environment that comes with many functionalities, including its own Vagrant and Docker containers. To set up the developers' environment, start off by cloning our source code from GitHub , like so: git clone https://github.com/neutronX/django-markdownx.git One that's done, change to the cloned directory and run: python3 dev.py -h to see the options available. Quick reference \\u00b6 -h , --help \\u00b6 Show the help message and exit. -v , --vagrant \\u00b6 Install Vagrant development environment (requires Vagrant). -d , --docker \\u00b6 Install Docker development environment (requires Docker). -c , --clean \\u00b6 Clean up the development files (only the ones that have been automatically created). -run-vagrant \\u00b6 Run vagrant development environment (runs --vagrant if the files don't already exist). Vagrant must be installed on your machine. -run-docker \\u00b6 Run docker development environment (runs --docker if the files don't already exist). Docker must already be installed on your machine, and Docker Daemon must be up and running. -no-container \\u00b6 Create development files without a container-based development environment (creates manage.py and runtests.py ). Optional \\u00b6 --with-docs \\u00b6 Install documentation development environment. --with-npm-settings \\u00b6 Install npm installation environment, including package.json for front-end (TypeScript) development (requires node.js and npm ). Note --with-docs and --with-npm-settings are optional and need to be accompanied by one of the required arguments. To save the changes made within the developers' environment, use -c or --clean ; and you will be asked if you would like to override the existing settings. Do not commit your changes before doing this . Example \\u00b6 This will install the following files: manage.py runtests.py Makefile create_docs.py It will also install the requirements for compiling the documentations. You do not need to create the documentations locally if you do not intend to change them. Although you are welcome to do so, for minor changes, it is probably easier to report an issue on GitHub as compiling the documentations can be somewhat tricky. python3 dev.py -no-container --with-docs However, if you still want to run a preview of the edited documentation, use the following command to see the result (it will run documentation preview on port http://localhost:8001 ) mkdocs serve Once done, please run: python3 dev.py -c to clean the installed files. If any of them have been altered, you will be asked for additional instructions as to whether to save the changes or discard them and hold onto the default. Tests \\u00b6 Django packages require manage.py and more often than not, settings.py files to run. This introduces a challenge for testing apps outside of a fully constructed project environment. This is one of the reasons why we introduced the developers' environment, which allows for a fully setup container ( Vagrant or Docker ) to create an inclusive virtual server that can be used to run MarkdownX independently. Attention You need to have either Vagrant or Docker along with Oracle VirtualBox installed and configured to run either of these. Note Vagrant will attempt to download and install Ubuntu Xenial, whilst Docker uses the default operating system if one already exists. To take advantage of this, you should clone the source code from GitHub as explained above, and depending on your container of choice, follow these instructions: Vagrant \\u00b6 python3 dev.py --vagrant Files will be created: Vagrantfile bootstrap.sh runtests.py manage.py package.json python3 dev.py -run-vagrant Connect to server using http://localhost:8000/ or http://127.0.0.1:8000/ Docker \\u00b6 python3 dev.py --docker Files will be created: Dockerfile docker-compose.yml entrypoint.sh runtests.py manage.py package.json python3 dev.py -run-docker Connect to server using http://localhost:8000/ or http://127.0.0.1:8000/ Tip Any changes made to the code whilst the container is up and running is automatically reflected without the need to restart the container. Cleanup \\u00b6 Once done, please run: python3 dev.py -c to clean the installed files. If any of them have been altered, you will be asked for additional instructions as to whether to save the changes or discard them and hold onto the default.\",\"title\":\"Contributions\"},{\"location\":\"contributions/#contributions\",\"text\":\"We welcome and encourage contributions of all nature; from pointing out an error or a potential problem, to translations, to feature requests, and pull requests. We have a implemented a fully comprehensive developers' environment that comes with many functionalities, including its own Vagrant and Docker containers. To set up the developers' environment, start off by cloning our source code from GitHub , like so: git clone https://github.com/neutronX/django-markdownx.git One that's done, change to the cloned directory and run: python3 dev.py -h to see the options available.\",\"title\":\"Contributions\"},{\"location\":\"contributions/#quick-reference\",\"text\":\"\",\"title\":\"Quick reference\"},{\"location\":\"contributions/#-h-help\",\"text\":\"Show the help message and exit.\",\"title\":\"-h, --help\"},{\"location\":\"contributions/#-v-vagrant\",\"text\":\"Install Vagrant development environment (requires Vagrant).\",\"title\":\"-v, --vagrant\"},{\"location\":\"contributions/#-d-docker\",\"text\":\"Install Docker development environment (requires Docker).\",\"title\":\"-d, --docker\"},{\"location\":\"contributions/#-c-clean\",\"text\":\"Clean up the development files (only the ones that have been automatically created).\",\"title\":\"-c, --clean\"},{\"location\":\"contributions/#-run-vagrant\",\"text\":\"Run vagrant development environment (runs --vagrant if the files don't already exist). Vagrant must be installed on your machine.\",\"title\":\"-run-vagrant\"},{\"location\":\"contributions/#-run-docker\",\"text\":\"Run docker development environment (runs --docker if the files don't already exist). Docker must already be installed on your machine, and Docker Daemon must be up and running.\",\"title\":\"-run-docker\"},{\"location\":\"contributions/#-no-container\",\"text\":\"Create development files without a container-based development environment (creates manage.py and runtests.py ).\",\"title\":\"-no-container\"},{\"location\":\"contributions/#optional\",\"text\":\"\",\"title\":\"Optional\"},{\"location\":\"contributions/#-with-docs\",\"text\":\"Install documentation development environment.\",\"title\":\"--with-docs\"},{\"location\":\"contributions/#-with-npm-settings\",\"text\":\"Install npm installation environment, including package.json for front-end (TypeScript) development (requires node.js and npm ). Note --with-docs and --with-npm-settings are optional and need to be accompanied by one of the required arguments. To save the changes made within the developers' environment, use -c or --clean ; and you will be asked if you would like to override the existing settings. Do not commit your changes before doing this .\",\"title\":\"--with-npm-settings\"},{\"location\":\"contributions/#example\",\"text\":\"This will install the following files: manage.py runtests.py Makefile create_docs.py It will also install the requirements for compiling the documentations. You do not need to create the documentations locally if you do not intend to change them. Although you are welcome to do so, for minor changes, it is probably easier to report an issue on GitHub as compiling the documentations can be somewhat tricky. python3 dev.py -no-container --with-docs However, if you still want to run a preview of the edited documentation, use the following command to see the result (it will run documentation preview on port http://localhost:8001 ) mkdocs serve Once done, please run: python3 dev.py -c to clean the installed files. If any of them have been altered, you will be asked for additional instructions as to whether to save the changes or discard them and hold onto the default.\",\"title\":\"Example\"},{\"location\":\"contributions/#tests\",\"text\":\"Django packages require manage.py and more often than not, settings.py files to run. This introduces a challenge for testing apps outside of a fully constructed project environment. This is one of the reasons why we introduced the developers' environment, which allows for a fully setup container ( Vagrant or Docker ) to create an inclusive virtual server that can be used to run MarkdownX independently. Attention You need to have either Vagrant or Docker along with Oracle VirtualBox installed and configured to run either of these. Note Vagrant will attempt to download and install Ubuntu Xenial, whilst Docker uses the default operating system if one already exists. To take advantage of this, you should clone the source code from GitHub as explained above, and depending on your container of choice, follow these instructions:\",\"title\":\"Tests\"},{\"location\":\"contributions/#vagrant\",\"text\":\"python3 dev.py --vagrant Files will be created: Vagrantfile bootstrap.sh runtests.py manage.py package.json python3 dev.py -run-vagrant Connect to server using http://localhost:8000/ or http://127.0.0.1:8000/\",\"title\":\"Vagrant\"},{\"location\":\"contributions/#docker\",\"text\":\"python3 dev.py --docker Files will be created: Dockerfile docker-compose.yml entrypoint.sh runtests.py manage.py package.json python3 dev.py -run-docker Connect to server using http://localhost:8000/ or http://127.0.0.1:8000/ Tip Any changes made to the code whilst the container is up and running is automatically reflected without the need to restart the container.\",\"title\":\"Docker\"},{\"location\":\"contributions/#cleanup\",\"text\":\"Once done, please run: python3 dev.py -c to clean the installed files. If any of them have been altered, you will be asked for additional instructions as to whether to save the changes or discard them and hold onto the default.\",\"title\":\"Cleanup\"},{\"location\":\"customization/\",\"text\":\"Customization \\u00b6 General (ex. settings) \\u00b6 Widget \\u00b6 The default widget is as seen here . If you would like to customise this; for instance, using Bootstrap v3 to implement side-by-side panes (as seen in :doc: preview animation {% include 'django/forms/widgets/textarea.html' %}
{% include 'django/forms/widgets/textarea.html' %}
\n \n\n \n \n \n\n
\n\n \n
\n\n \n
\n \n
\n \n \n \n\n
\n Search Results
\n\n \n\n\n Searching...\n
\n\n\n \n \n \n \n GitHub\n \n \n \n \n \n
\n \n \n \n \n \n \n\n\n\n"
},
{
"path": "docs/sitemap.xml",
"content": "\n\n \n\n \n \n \n\n
\n\n \n
\n\n \n
\n \n
\n \n \n \n
\n
\n Translations¶
\nDjango's strength is in its global community. Similarly, MarkdownX developers come from across the world too. We are therefore commit to make the plugin as inclusive as possible. To this end, we provide translation of all messages produced by MarkdownX to various languages.
\nCurrent languages¶
\n- \n
- English \n
- Polish (Polski) \n
- German (Deutsch) \n
- French (Français) \n
- Persian (فارسی) \n
- Dutch (Nederlands) \n
\n
Your language is not included?¶
\nWanna contribute?\nWhy not help us with the translation of messages? It's not really that long.
\nEven more?\nHelp us translate the documentations.
\n \n\n \n \n \n GitHub\n \n \n \n « Previous\n \n \n Next »\n \n \n
\n \n \n \n \n \n \n\n\n\n"
},
{
"path": "docs-src/contributions.md",
"content": "# Contributions\n\nWe welcome and encourage contributions of all nature; from pointing out an error or a potential problem, to translations, to feature requests, and pull requests.\n\nWe have a implemented a fully comprehensive developers' environment that comes with many functionalities, including its\nown [Vagrant](https://www.vagrantup.com) and [Docker](https://www.docker.com) containers.\n\n\t\nTo set up the developers' environment, start off by cloning our source code from [GitHub](https://github.com/neutronX/django-markdownx), like so:\n\n```bash\ngit clone https://github.com/neutronX/django-markdownx.git\n```\n\nOne that's done, change to the cloned directory and run:\n\n```python\npython3 dev.py -h\n```\n\nto see the options available.\n\n## Quick reference\n\n### ``-h``, ``--help``\nShow the help message and exit.\n\n### ``-v``, ``--vagrant``\nInstall Vagrant development environment (requires Vagrant).\n\n### ``-d``, ``--docker``\nInstall Docker development environment (requires Docker).\n\n### ``-c``, ``--clean``\nClean up the development files (only the ones that have been automatically created).\n\n### ``-run-vagrant``\nRun vagrant development environment (runs ``--vagrant`` if the files don't already exist). Vagrant must be installed on your machine.\n\n### ``-run-docker``\nRun docker development environment (runs ``--docker`` if the files don't already exist). Docker must already be installed on your machine, and Docker Daemon must be up and running.\n\n### ``-no-container``\nCreate development files without a container-based development environment (creates `manage.py` and `runtests.py`).\n\n## Optional\n\n### ``--with-docs``\nInstall documentation development environment.\n\n### ``--with-npm-settings``\nInstall npm installation environment, including `package.json` for front-end (TypeScript) development (requires ``node.js`` and ``npm``).\n\n!!! note\n - ``--with-docs`` and ``--with-npm-settings`` are optional and need to be accompanied by one of the required arguments.\n - To save the changes made within the developers' environment, use ``-c`` or ``--clean``; and you will be asked if you\n would like to override the existing settings. **Do not commit your changes before doing this**.\n\n## Example\n\nThis will install the following files:\n\n- manage.py\n- runtests.py\n- Makefile\n- create_docs.py\n\nIt will also install the requirements for compiling the documentations. You do not \nneed to create the documentations locally if you do not intend to change them. \nAlthough you are welcome to do so, for minor changes, it is probably easier to report \nan issue on GitHub as compiling the documentations can be somewhat tricky.\n\n```bash\npython3 dev.py -no-container --with-docs\n```\n\nHowever, if you still want to run a preview of the edited documentation, use the \nfollowing command to see the result (it will run documentation preview on port \n`http://localhost:8001`)\n\n```bash\nmkdocs serve\n```\n\nOnce done, please run:\n\n```bash\npython3 dev.py -c\n```\n\nto clean the installed files. If any of them have been altered, you will be asked for additional instructions as to whether to save the changes or discard them and hold onto the default.\n\n## Tests\n\nDjango packages require `manage.py` and more often than not, `settings.py` files to run. This introduces a challenge for testing apps outside of a fully constructed project environment. This is one of the reasons why we introduced the developers' environment, which allows for a fully setup container ([Vagrant](https://www.vagrantup.com) or [Docker](https://www.docker.com)) to create an inclusive virtual server that can be used to run MarkdownX independently.\n\n!!! attention\n You need to have either [Vagrant](https://www.vagrantup.com) or [Docker](https://www.docker.com) along with [Oracle VirtualBox](https://www.virtualbox.org) installed and configured to run either of these.\n\n!!! note\n Vagrant will attempt to download and install Ubuntu Xenial, whilst Docker uses the default operating system if one already exists.\n\nTo take advantage of this, you should clone the source code from [GitHub](https://github.com/neutronX/django-markdownx) as explained above, and depending on your container of choice, follow these instructions:\n\n## Vagrant\n\n```bash\npython3 dev.py --vagrant\n```\n\nFiles will be created:\n\n- Vagrantfile\n- bootstrap.sh\n- runtests.py\n- manage.py\n- package.json\n\n```bash\npython3 dev.py -run-vagrant\n```\n\nConnect to server using ```http://localhost:8000/``` or ```http://127.0.0.1:8000/```\n\n## Docker\n\n```bash\npython3 dev.py --docker\n```\n\nFiles will be created:\n\n- Dockerfile\n- docker-compose.yml\n- entrypoint.sh\n- runtests.py\n- manage.py\n- package.json\n\n```bash\npython3 dev.py -run-docker\n```\n\nConnect to server using ```http://localhost:8000/``` or ```http://127.0.0.1:8000/```\n\n---\n\n!!! tip\n Any changes made to the code whilst the container is up and running is automatically reflected without the need to restart the container.\n \n## Cleanup\n\nOnce done, please run:\n\n```bash\npython3 dev.py -c\n```\n\nto clean the installed files. If any of them have been altered, you will be asked for additional instructions as to whether to save the changes or discard them and hold onto the default.\n"
},
{
"path": "docs-src/customization.md",
"content": "# Customization\n\n## General (ex. settings)\n\n### Widget\n\nThe default widget is as seen [here](https://github.com/neutronX/django-markdownx/blob/master/markdownx/templates/markdownx/widget.html).\n\nIf you would like to customise this; for instance, using [Bootstrap v3](https://getbootstrap.com) to implement side-by-side panes (as seen in :doc:`preview animation\n
\n```\n\n### Fields\n\nWe have ensured that MarkdownX is fully extensible and provides a high degree of flexibility in development.\n\nThere are times that you may wish to Markdownify a different type of field, or utilize your own customized widget. To accommodate this, we have provided the tools to apply MarkdownX infrastructure to other fields through *Widgets*.\n\nFor instance, to apply MarkdownX to ``TextField`` instances in your Django Admins, you can override the default widget in the Admins module in `admin.py` of your Django App as follows:\n\n```python\nfrom django.db import models\nfrom django.contrib import admin\n\nfrom markdownx.widgets import AdminMarkdownxWidget\n\nfrom .models import MyModel\n\n\nclass MyModelAdmin(admin.ModelAdmin):\n formfield_overrides = {\n models.TextField: {'widget': AdminMarkdownxWidget},\n }\n\n\nadmin.site.register(MyModel, MyModelAdmin)\n```\n\n### Image tags\n\nMarkdown uses ``![]()`` tag by default to insert uploaded image file. This generates a simple (X)HTML ``\n {% include 'django/forms/widgets/textarea.html' %}\n
\n \n \n
\n\n**PyPi:** [https://pypi.org/project/django-markdownx/](https://pypi.org/project/django-markdownx/)\n\n## Key features\n\n* Raw editing.\n* Live preview.\n* Drag & drop image uploads (automatically stored in the designated location in the *Media* directory).\n* Customizable image insertion tag.\n* Definition of maximum size for an image.\n* Definition of acceptable image formats (PNG, JPEG, SVG).\n* Image manipulations (compression, size reduction, cropping, upscaling).\n* Pre- and post- text modification.\n* Easy template customization, layout modification, and personalization.\n* Multiple editors per page.\n* Django Admin support.\n\n## Preview\n\n\n\n## Acknowledgements\n\nWe acknowledge and appreciate every contribution made towards improving **Django MarkdownX**, a list of which can be\nfound on our [GitHub contributors page](https://github.com/adi-/django-markdownx/graphs/contributors).\n" }, { "path": "docs-src/installation.md", "content": "# Installation\n\n## Using PIP\n\nDjango MarkdownX may be installed directly using Python Package Index (PyPi):\n\n```bash\npip install django-markdownx\n```\n\n## From the source\n\nShould you wish to download and install it using the source code, you can do as follows:\n\n!!! note\n\tMake sure you have activated your virtual environment if you’re using one.\n\t\nWe start off by downloading the source code from GitHub and navigate to the downloaded directory:\n\n```bash\ngit clone https://github.com/neutronX/django-markdownx.git\ncd django-markdownx/\n```\n\nInstall the package.\n\n```bash\npython3 setup.py install\n```\n" }, { "path": "docs-src/javascript.md", "content": "# JavaScript\n\n## Events\n\nSome MarkdownX processes trigger events that may be utilized for different purposes. To handle such events in JavaScript, you may take advantage of event listeners as exemplified below:\n\n- [`markdownx.init`](#markdownxinit)\n- [`markdownx.update`](#markdownxupdate)\n- [`markdownx.updateError`](#markdownxupdateerror)\n- [`markdownx.markdownx.fileUploadBegin`](#markdownxmarkdownxfileuploadbegin)\n- [`markdownx.fileUploadEnd`](#markdownxfileuploadend)\n- [`markdownx.fileUploadError`](#markdownxfileuploaderror)\n\n\n### `markdownx.init`\n\nTriggered after jQuery plugin init. `markdownx.init` is an event that does *not* return a response.\n\nJavaScript ECMA 2015+:\n\n```javascript\nlet element = document.getElementsByClassName('markdownx');\n\nObject.keys(element).map(key =>\n\n element[key].addEventListener('markdownx.init', () => console.log(\"MarkdownX initialized.\"))\n\n);\n```\n\n### `markdownx.update`\n\nTriggered when editor text is markdownified. Returns: **response** (*string*) variable containing markdownified text.\n\nJavaScript ECMA 2015+:\n\n```javascript\nlet element = document.getElementsByClassName('markdownx');\n\nObject.keys(element).map(key =>\n\n element[key].addEventListener('markdownx.update', event => console.log(event.detail))\n\n);\n```\n\n### `markdownx.updateError`\n\nTriggered when a problem occurred during markdownify.\n\n### `markdownx.markdownx.fileUploadBegin`\n\nTriggered when the file is posted.\n\n### `markdownx.fileUploadEnd`\n\nTriggered when the file has been uploaded.\n\n### `markdownx.fileUploadError`\n\nTriggered if the upload didn’t work.\n\n## Compatibility\n\nWe rely on JavaScript to handle front-end events (e.g. trans-compilation of Markdown to HTML, uploading image).\n\nMarkdownX's JavaScript code is written in TypeScript using Pure JavaScript and under ECMA 2016 standard.\n\nCurrently, the code is trans-compiled into ECMA 5 (approved in 2011) to provide support for older browsers, specifically IE 10+. See additional detailed on [browser compatibilities](https://kangax.github.io/compat-table/es5/).\n" }, { "path": "docs-src/license.md", "content": "# License\n\nMarkdownX is licensed under the [2-clause BSD](https://opensource.org/licenses/BSD-2-Clause) license, and Open Source Initiative approved license.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\nThis software is provided by the copyright holders and contributors \"as is\" and\nany express or implied warranties, including, but not limited to, the implied\nwarranties of merchantability and fitness for a particular purpose are\ndisclaimed. in no event shall the copyright owner or contributors be liable for\nany direct, indirect, incidental, special, exemplary, or consequential damages\n(including, but not limited to, procurement of substitute goods or services;\nloss of use, data, or profits; or business interruption) however caused and\non any theory of liability, whether in contract, strict liability, or tort\n(including negligence or otherwise) arising in any way out of the use of this\nsoftware, even if advised of the possibility of such damage.\n" }, { "path": "docs-src/requirements.txt", "content": "mkdocs\npymdown-extensions\n" }, { "path": "docs-src/translations.md", "content": "# Translations\n\nDjango's strength is in its global community. Similarly, MarkdownX developers come from across the world too. We are therefore commit to make the plugin as inclusive as possible. To this end, we provide translation of all messages produced by MarkdownX to various languages.\n\n## Current languages\n\n- English\n- Polish (Polski)\n- German (Deutsch)\n- French (Français)\n- Persian (فارسی)\n- Dutch (Nederlands)\n\n---\n\n### Your language is not included?\n\n**Wanna contribute?**\nWhy not help us with the translation of messages? It's not really that long.\n\n**Even more?**\nHelp us translate the documentations.\n" }, { "path": "markdownx/__init__.py", "content": "\"\"\"\nDjango MarkdownX\n================\n\n|PyPi_Status| |Build_Status| |Format| |Supported_versions_of_Python| |Supported_versions_of_Django| |License|\n\n.. raw:: html\n\n \n \n\n------------\n\nDocumentations\n--------------\n\nDjango MarkdownX is a comprehensive Markdown_ plugin built for Django_, the renowned high-level\nPython web framework, with flexibility, extensibility, and ease-of-use at its core.\n\n\nKey features\n````````````\n\n* Raw editing.\n* Live preview.\n* Drag & drop image uploads (automatically stored in the designated location in the *Media* directory).\n* Customizable image insertion tag.\n* Definition of maximum size for an image.\n* Definition of acceptable image formats (PNG, JPEG, SVG).\n* Image manipulations (compression, size reduction, cropping, upscaling).\n* Pre- and post- text modification.\n* Easy template customization, layout modification, and personalization.\n* Multiple editors per page.\n* Django Admin support.\n\n.. image:: https://github.com/neutronX/django-markdownx/raw/master/django-markdownx-preview.gif?raw=true\n :target: https://github.com/neutronX/django-markdownx\n :align: center\n :alt: django-markdownx preview\n\n.. _Markdown: https://en.wikipedia.org/wiki/Markdown\n.. _Django: https://www.djangoproject.com\n\n.. |PyPi_Status| image:: https://img.shields.io/pypi/status/django-markdownx.svg\n.. |Build_Status| image:: https://img.shields.io/travis/neutronX/django-markdownx.svg\n.. |Format| image:: https://img.shields.io/pypi/format/django-markdownx.svg\n.. |Supported_versions_of_Python| image:: https://img.shields.io/pypi/pyversions/django-markdownx.svg\n.. |Supported_versions_of_Django| image:: https://img.shields.io/badge/Django-2.0,%202.1,%202.2,%203.0-green.svg\n.. |License| image:: https://img.shields.io/pypi/l/django-markdownx.svg\n\n------------\n\"\"\"\n\n# ~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=\n# Imports\n# ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-\n# None\n\n# ~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=\n# Documentations\n# ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-\n__credits__ = 'Adi, Pouria Hadjibagheri'\n__copyright__ = 'Copyright 2017'\n__license__ = 'BSD'\n__maintainer__ = 'Adi, Pouria Hadjibagheri'\n__url__ = 'https://github.com/neutronX/django-markdownx'\n__version__ = '4.0.9'\n__description__ = 'A comprehensive Markdown editor built for Django.'\n# ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-\n\n\nif __name__ == '__main__':\n raise RuntimeError(\n 'MarkdownX is a Django plugin. It is not meant to be run as an stand-alone module.'\n )\n" }, { "path": "markdownx/admin.py", "content": "from django.contrib import admin\n\nfrom .models import MarkdownxField\nfrom .widgets import AdminMarkdownxWidget\n\n\nclass MarkdownxModelAdmin(admin.ModelAdmin):\n \"\"\"\n Django admin representation for ``MarkdownxField`` in models.\n\n See **Django Admin** in :doc:`../../example` for additional information.\n \"\"\"\n\n formfield_overrides = {\n MarkdownxField: {'widget': AdminMarkdownxWidget}\n }\n" }, { "path": "markdownx/exceptions.py", "content": "from django.forms import ValidationError\nfrom django.utils.translation import gettext_lazy as _\n\n\nclass MarkdownxImageUploadError(ValidationError):\n \"\"\"\n Custom **MarkdownX** exceptions.\n \"\"\"\n\n @classmethod\n def not_uploaded(cls):\n \"\"\"\n No file is available to upload.\n\n :return: Locale compatible version of the error with the following message:\n\n - No files have been uploaded.\n\n :rtype: MarkdownxImageUploadError\n \"\"\"\n return cls(_('No files have been uploaded.'))\n\n @classmethod\n def unsupported_format(cls):\n \"\"\"\n\n The file is of a format not defined in :guilabel:`settings.py`\n or if default, in :guilabel:`markdownx/settings.py`.\n\n :return: Locale compatible version of the error with the following message:\n\n - File type is not supported.\n\n :rtype: MarkdownxImageUploadError\n \"\"\"\n return cls(_('File type is not supported.'))\n\n @classmethod\n def invalid_size(cls, current, expected):\n \"\"\"\n The file is larger in size that the maximum allow in :guilabel:`settings.py` (or the default).\n\n :param current: Current size of the file.\n :type current: float, int\n :param expected: Expected (maximum permitted) size of the file.\n :type expected: float, int\n :return: Locale compatible version of the error with the following message:\n\n - Please keep file size under %(max)s. Current file size: %(current)s.'\n\n :rtype: MarkdownxImageUploadError\n \"\"\"\n from django.template.defaultfilters import filesizeformat\n\n return cls(\n _('Please keep file size under %(max)s. Current file size: %(current)s.') % {\n 'max': filesizeformat(expected),\n 'current': filesizeformat(current)\n }\n )\n" }, { "path": "markdownx/fields.py", "content": "from django import forms\n\nfrom .widgets import MarkdownxWidget\n\n\nclass MarkdownxFormField(forms.CharField):\n \"\"\"\n Used in FormFields as a Markdown enabled replacement for ``CharField``.\n \"\"\"\n\n def __init__(self, *args, **kwargs):\n \"\"\"\n Arguments are similar to Django's default ``CharField``.\n\n See Django's `documentations on CharField`_ for additional information.\n\n .. _docs on Charfield: https://docs.djangoproject.com/en/dev/ref/models/fields/#django.db.models.CharField\n \"\"\"\n super(MarkdownxFormField, self).__init__(*args, **kwargs)\n\n if issubclass(self.widget.__class__, forms.widgets.MultiWidget):\n is_markdownx_widget = any(\n issubclass(item.__class__, MarkdownxWidget)\n for item in getattr(self.widget, 'widgets', list())\n )\n\n if not is_markdownx_widget:\n self.widget = MarkdownxWidget()\n\n elif not issubclass(self.widget.__class__, MarkdownxWidget):\n self.widget = MarkdownxWidget()\n" }, { "path": "markdownx/forms.py", "content": "from collections import namedtuple\nfrom io import BytesIO\nfrom os import SEEK_END\nfrom os import SEEK_SET\nfrom os import path\nfrom uuid import uuid4\n\nfrom django import forms\nfrom django.core.files.storage import default_storage\nfrom django.core.files.uploadedfile import InMemoryUploadedFile\n\nfrom .exceptions import MarkdownxImageUploadError\nfrom .settings import MARKDOWNX_IMAGE_MAX_SIZE\nfrom .settings import MARKDOWNX_MEDIA_PATH\nfrom .settings import MARKDOWNX_SKIP_RESIZE\nfrom .settings import MARKDOWNX_SVG_JAVASCRIPT_PROTECTION\nfrom .settings import MARKDOWNX_UPLOAD_CONTENT_TYPES\nfrom .settings import MARKDOWNX_UPLOAD_MAX_SIZE\nfrom .utils import scale_and_crop\nfrom .utils import xml_has_javascript\n\n\nclass ImageForm(forms.Form):\n \"\"\"\n Used for the handling of images uploaded using the editor through :guilabel:`AJAX`.\n \"\"\"\n\n image = forms.FileField()\n\n # Separately defined as it needs to be\n # processed a text file rather than image.\n _SVG_TYPE = 'image/svg+xml'\n\n def save(self, commit=True):\n \"\"\"\n Saves the uploaded image in the designated location.\n\n If image type is not liste as ``MARKDOWNX_SKIP_RESIZE``, a byteIO of image\n content_type is created and subsequently save; otherwise, the image is saved\n in its existing ``charset`` with its existing mime type.\n\n *Note*: The dimension of image files (excluding SVG) are set using ``PIL``.\n\n :param commit: If ``True``, the file is saved to the disk;\n otherwise, it is held in the memory.\n :type commit: bool\n :return: An instance of saved image if ``commit is True``,\n else ``namedtuple(path, image)``.\n :rtype: bool, namedtuple\n \"\"\"\n image = self.files.get('image')\n content_type = image.content_type\n file_name = image.name\n image_extension = content_type.split('/')[-1].upper()\n image_size = image.size\n\n if content_type.lower() not in MARKDOWNX_SKIP_RESIZE:\n # Processing the raster graphic image.\n # Note that some graphics do not require (or enable)\n # additional processing (such as GIF or SVG) and\n # may be stored as uploaded.\n image = self._process_raster(image, image_extension)\n image_size = image.tell()\n image.seek(0, SEEK_SET)\n\n # Processed file (or the actual file in the case of SVG) is now\n # saved in the memory as a Django object.\n uploaded_image = InMemoryUploadedFile(\n file=image,\n field_name=None,\n name=file_name,\n content_type=content_type,\n size=image_size,\n charset=None\n )\n\n if (content_type.lower() == self._SVG_TYPE\n and MARKDOWNX_SVG_JAVASCRIPT_PROTECTION\n and xml_has_javascript(uploaded_image.read())):\n\n raise MarkdownxImageUploadError(\n 'Failed security monitoring: SVG file contains JavaScript.'\n )\n\n return self._save(uploaded_image, file_name, commit)\n\n def _save(self, image, file_name, commit):\n \"\"\"\n Final saving process, called internally after processing tasks are complete.\n\n :param image: Prepared image\n :type image: django.core.files.uploadedfile.InMemoryUploadedFile\n :param file_name: Name of the file using which the image is to be saved.\n :type file_name: str\n :param commit: If ``True``, the image is saved onto the disk.\n :type commit: bool\n :return: URL of the uploaded image ``commit=True``, otherwise a namedtuple\n of ``(path, image)`` where ``path`` is the absolute path generated\n for saving the file, and ``image`` is the prepared image.\n :rtype: str, namedtuple\n \"\"\"\n # Defining a universally unique name for the file\n # to be saved on the disk.\n unique_file_name = self.get_unique_file_name(file_name)\n full_path = path.join(MARKDOWNX_MEDIA_PATH, unique_file_name)\n\n if commit:\n default_storage.save(full_path, image)\n return default_storage.url(full_path)\n\n # If `commit is False`, return the path and in-memory image.\n image_data = namedtuple('image_data', ['path', 'image'])\n return image_data(path=full_path, image=image)\n\n @staticmethod\n def _process_raster(image, extension):\n \"\"\"\n Processing of raster graphic image using Python Imaging Library (PIL).\n\n This is where raster graphics are processed to the specifications\n as defined in ``settings.py``.\n\n *Note*: The file needs to be uploaded and saved temporarily in the\n memory to enable processing tasks using Python Imaging Library (PIL)\n to take place and subsequently retained until written onto the disk.\n\n :param image: Non-SVG image as processed by Django.\n :type image: django.forms.BaseForm.file\n :param extension: Image extension (e.g.: png, jpg, gif)\n :type extension: str\n :return: The image object ready to be written into a file.\n :rtype: BytesIO\n \"\"\"\n thumb_io = BytesIO()\n preped_image = scale_and_crop(image, **MARKDOWNX_IMAGE_MAX_SIZE)\n preped_image.save(thumb_io, extension, **MARKDOWNX_IMAGE_MAX_SIZE)\n thumb_io.seek(0, SEEK_END)\n return thumb_io\n\n @staticmethod\n def get_unique_file_name(file_name):\n \"\"\"\n Generates a universally unique ID using Python ``UUID`` and attaches the\n extension of file name to it.\n\n :param file_name: Name of the uploaded file, including the extension.\n :type file_name: str\n :return: Universally unique ID, ending with the extension extracted\n from ``file_name``.\n :rtype: str\n \"\"\"\n extension = 1\n extension_dot_index = 1\n\n file_name = \"{unique_name}.{extension}\".format(\n unique_name=uuid4(),\n extension=path.splitext(file_name)[extension][extension_dot_index:]\n )\n return file_name\n\n def clean(self):\n \"\"\"\n Checks the upload against allowed extensions and maximum size.\n\n :return: Upload\n \"\"\"\n upload = self.cleaned_data.get('image')\n\n # -----------------------------------------------\n # See comments in `self._error_templates` for\n # additional information on each error.\n # -----------------------------------------------\n if not upload:\n raise MarkdownxImageUploadError.not_uploaded()\n\n content_type = upload.content_type\n file_size = upload.size\n\n if content_type not in MARKDOWNX_UPLOAD_CONTENT_TYPES:\n\n raise MarkdownxImageUploadError.unsupported_format()\n\n elif file_size > MARKDOWNX_UPLOAD_MAX_SIZE:\n\n raise MarkdownxImageUploadError.invalid_size(\n current=file_size,\n expected=MARKDOWNX_UPLOAD_MAX_SIZE\n )\n\n return upload\n" }, { "path": "markdownx/locale/de/LC_MESSAGES/django.po", "content": "# SOME DESCRIPTIVE TITLE.\n# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER\n# This file is distributed under the same license as the PACKAGE package.\n# FIRST AUTHOR
\n {% include 'django/forms/widgets/textarea.html' %}\n \n
\n"
},
{
"path": "markdownx/tests/__init__.py",
"content": ""
},
{
"path": "markdownx/tests/models.py",
"content": "from django.db import models\n\nfrom markdownx.models import MarkdownxField\n\n\nclass MyModel(models.Model):\n \"\"\"\n\n \"\"\"\n markdownx_field = MarkdownxField()\n\n class Meta:\n app_label = 'MyModel'\n"
},
{
"path": "markdownx/tests/templates/test_view.html",
"content": "\n\n\n\n\n \n {{ form.media }}\n\n\n"
},
{
"path": "markdownx/tests/tests.py",
"content": "import os\nimport re\nfrom django.test import TestCase\nfrom django.urls import reverse\n\n\nclass SimpleTest(TestCase):\n\n def test_upload(self):\n url = reverse('markdownx_upload')\n with open('markdownx/tests/static/django-markdownx-preview.png', 'rb') as fp:\n response = self.client.post(url, {'image': fp}, HTTP_X_REQUESTED_WITH='XMLHttpRequest')\n json = response.json()\n\n self.assertEqual(response.status_code, 200)\n self.assertIn('image_code', json)\n\n match = re.findall(r'(markdownx/[\\w\\-]+\\.png)', json['image_code'])\n try:\n if match:\n os.remove(match[0])\n except OSError:\n pass\n"
},
{
"path": "markdownx/tests/urls.py",
"content": "from django.conf.urls import include\nfrom django.urls import path\n\nfrom .views import TestView\n\nurlpatterns = [\n path('testview/', TestView.as_view()),\n path('markdownx/', include('markdownx.urls')),\n]\n"
},
{
"path": "markdownx/tests/views.py",
"content": "from django.views.generic.edit import CreateView\n\nfrom .models import MyModel\n\nclass TestView(CreateView):\n template_name = \"test_view.html\"\n model = MyModel\n fields = ['markdownx_field']\n"
},
{
"path": "markdownx/urls.py",
"content": "\"\"\"\n**MarkdownX** default URLs, to be added to URLs in the main project.\n\nSee URLs in :doc:`../../example` to learn more.\n\"\"\"\n\nfrom django.urls import path\n\nfrom .views import ImageUploadView\nfrom .views import MarkdownifyView\n\n\nurlpatterns = [\n path('upload/', ImageUploadView.as_view(), name='markdownx_upload'),\n path('markdownify/', MarkdownifyView.as_view(), name='markdownx_markdownify'),\n]\n"
},
{
"path": "markdownx/utils.py",
"content": "from PIL import Image\nfrom markdown import markdown\n\nfrom .settings import MARKDOWNX_MARKDOWN_EXTENSIONS\nfrom .settings import MARKDOWNX_MARKDOWN_EXTENSION_CONFIGS\n\n\n# TODO: try catch for file.open when image is corrupted\n\n\ndef markdownify(content):\n \"\"\"\n Trans-compiles Markdown text to HTML.\n\n :param content: Markdown text.\n :type content: str\n :return: HTML encoded text.\n :rtype: str\n \"\"\"\n md = markdown(\n text=content,\n extensions=MARKDOWNX_MARKDOWN_EXTENSIONS,\n extension_configs=MARKDOWNX_MARKDOWN_EXTENSION_CONFIGS\n )\n return md\n\n\ndef _crop(im, target_x, target_y):\n \"\"\"\n Crops the image to the given specifications.\n\n :param im: Instance of the image.\n :type im: PIL Image\n :param target_x: New x-axis.\n :type target_x: int\n :param target_y: New y-axis\n :type target_y: int\n :return: Cropped image.\n :rtype: PIL.Image\n \"\"\"\n # Use integer values now.\n source_x, source_y = im.size\n # Difference between new image size and requested size.\n diff_x = int(source_x - min(source_x, target_x))\n diff_y = int(source_y - min(source_y, target_y))\n\n if diff_x or diff_y:\n # Center cropping (default).\n halfdiff_x, halfdiff_y = diff_x // 2, diff_y // 2\n box = [\n halfdiff_x,\n halfdiff_y,\n min(source_x, int(target_x) + halfdiff_x),\n min(source_y, int(target_y) + halfdiff_y)\n ]\n\n # Finally, crop the image!\n im = im.crop(box)\n return im\n\n\ndef _scale(im, x, y):\n \"\"\"\n Scales the image to the given specifications.\n\n :param im: Instance of the image.\n :type im: PIL Image\n :param x: x-axis size.\n :type x: int\n :param y: y-axis size.\n :type y: int\n :return: Scaled image, re-sampled with anti-aliasing filter.\n :rtype: Image\n \"\"\"\n im = im.resize(\n (int(x), int(y)),\n resample=Image.Resampling.LANCZOS\n )\n return im\n\n\ndef scale_and_crop(image, size, crop=False, upscale=False, quality=None):\n \"\"\"\n Modifies raster graphic images to the specifications.\n\n :param image: Raster graphic image.\n :type image: BytesIO\n :param size: New size.\n :type size: int\n :param crop: Perform cropping or not.\n :type crop: bool\n :param upscale: Whether or not to upscale the image.\n :type upscale: bool\n :param quality: Quality of the new image in DPI.\n :type quality: int\n :return: Raster graphic image modified to the given specifications.\n :rtype: BytesIO\n \"\"\"\n # Open image and store format/metadata.\n image.open()\n im = Image.open(image)\n im_format, im_info = im.format, im.info\n if quality:\n im_info['quality'] = quality\n\n # Force PIL to load image data.\n im.load()\n\n source_x, source_y = map(float, im.size)\n target_x, target_y = map(float, size)\n\n if crop or not target_x or not target_y:\n scale = max(target_x / source_x, target_y / source_y)\n else:\n scale = min(target_x / source_x, target_y / source_y)\n\n # Handle one-dimensional targets.\n if not target_x:\n target_x = source_x * scale\n elif not target_y:\n target_y = source_y * scale\n\n if scale < 1.0 or (scale > 1.0 and upscale):\n im = _scale(im=im, x=source_x * scale, y=source_y * scale)\n\n if crop:\n im = _crop(im=im, target_x=target_x, target_y=target_y)\n\n # Close image and replace format/metadata, as PIL blows this away.\n im.format, im.info = im_format, im_info\n\n image.close()\n\n return im\n\n\ndef xml_has_javascript(data):\n \"\"\"\n Checks XML for JavaScript. See \"security\" in :doc:`customization <../../customization>` for\n additional information.\n\n :param data: Contents to be monitored for JavaScript injection.\n :type data: str, bytes\n :return: ``True`` if **data** contains JavaScript tag(s), otherwise ``False``.\n :rtype: bool\n \"\"\"\n from re import search, IGNORECASE, MULTILINE\n\n data = str(data, encoding='UTF-8')\n # ------------------------------------------------\n # Handles JavaScript nodes and stringified nodes.\n # ------------------------------------------------\n # Filters against \"script\" / \"if\" / \"for\" within node attributes.\n pattern = r'(<\\s*\\bscript\\b.*>.*)|(.*\\bif\\b\\s*\\(.?={2,3}.*\\))|(.*\\bfor\\b\\s*\\(.*\\))'\n\n found = search(\n pattern=pattern,\n string=data,\n flags=IGNORECASE | MULTILINE\n )\n\n if found is not None:\n return True\n\n # ------------------------------------------------\n # Handles JavaScript injection into attributes\n # for element creation.\n # ------------------------------------------------\n from xml.etree.ElementTree import fromstring\n\n parsed_xml = (\n (attribute, value)\n for elm in fromstring(data).iter()\n for attribute, value in elm.attrib.items()\n )\n\n for key, val in parsed_xml:\n if '\"' in val or \"'\" in val:\n return True\n\n # It is (hopefully) safe.\n return False\n"
},
{
"path": "markdownx/views.py",
"content": "from django.http import HttpResponse\nfrom django.http import JsonResponse\nfrom django.utils.module_loading import import_string\nfrom django.views.generic.edit import BaseFormView\nfrom django.views.generic.edit import View\n\nfrom .forms import ImageForm\nfrom .settings import MARKDOWNX_MARKDOWNIFY_FUNCTION\n\nmarkdownify_func = import_string(MARKDOWNX_MARKDOWNIFY_FUNCTION)\n\n\nclass MarkdownifyView(View):\n \"\"\"\n Conversion of Markdown to HTML.\n \"\"\"\n\n def post(self, request, *args, **kwargs):\n \"\"\"\n Handling of the conversion from Markdown to HTML using the conversion\n function in settings under ``MARKDOWNX_MARKDOWNIFY_FUNCTION``.\n\n :param request: HTTP request.\n :param args: Default Django POST arguments.\n :param kwargs: Default Django POST keyword arguments.\n :return: HTTP response\n :rtype: django.http.HttpResponse\n \"\"\"\n\n return HttpResponse(markdownify_func(request.POST['content']))\n\n\nclass ImageUploadView(BaseFormView):\n \"\"\"\n Handling requests for uploading images.\n \"\"\"\n\n # template_name = \"dummy.html\"\n form_class = ImageForm\n success_url = '/'\n\n def form_invalid(self, form):\n \"\"\"\n Handling of invalid form events.\n\n :param form: Django form instance.\n :type form: django.forms.Form\n :return: JSON response with the HTTP-400 error message for AJAX requests\n and the default response for HTTP requests.\n :rtype: django.http.JsonResponse, django.http.HttpResponse\n \"\"\"\n if self.request.headers.get('x-requested-with') == 'XMLHttpRequest':\n return JsonResponse(form.errors, status=400)\n\n response = super(ImageUploadView, self).form_invalid(form)\n return response\n\n def form_valid(self, form):\n \"\"\"\n If the form is valid, the contents are saved.\n\n If the **POST** request is AJAX (image uploads), a JSON response will be\n produced containing the Markdown encoded image insertion tag with the URL\n using which the uploaded image may be accessed.\n\n JSON response would be as follows:\n\n .. code-block:: bash\n\n { image_code: \"\" }\n\n :param form: Django form instance.\n :type form: django.forms.Form\n :return: JSON encoded Markdown tag for AJAX requests, and an appropriate\n response for HTTP requests.\n :rtype: django.http.JsonResponse, django.http.HttpResponse\n \"\"\"\n response = super(ImageUploadView, self).form_valid(form)\n\n if self.request.headers.get('x-requested-with') == 'XMLHttpRequest':\n image_path = form.save(commit=True)\n image_code = ''.format(image_path)\n return JsonResponse({'image_code': image_code})\n\n return response\n"
},
{
"path": "markdownx/widgets.py",
"content": "from django import forms\nfrom django.conf import settings\nfrom django.contrib.admin import widgets\nfrom django.core.exceptions import ImproperlyConfigured\n\nfrom .settings import MARKDOWNX_EDITOR_RESIZABLE\nfrom .settings import MARKDOWNX_SERVER_CALL_LATENCY\nfrom .settings import MARKDOWNX_UPLOAD_URLS_PATH\nfrom .settings import MARKDOWNX_URLS_PATH\n\n\ntry:\n DEBUG = getattr(settings, 'DEBUG', False)\nexcept ImproperlyConfigured:\n # Documentations work around.\n DEBUG = False\n\nminified = '.min' if not DEBUG else str()\n\n\nclass MarkdownxWidget(forms.Textarea):\n \"\"\"\n MarkdownX TextArea widget for forms. Markdown enabled version of\n Django \"TextArea\" widget.\n \"\"\"\n\n template_name = 'markdownx/widget.html'\n\n def get_context(self, name, value, attrs=None):\n \"\"\"\n Context for the template in Django\n \"\"\"\n try:\n attrs.update(self.add_markdownx_attrs(attrs))\n except AttributeError:\n attrs = self.add_markdownx_attrs(attrs)\n\n return super(MarkdownxWidget, self).get_context(name, value, attrs)\n\n def render(self, name, value, attrs=None, renderer=None):\n \"\"\"\n Rendering the template and attributes\n \"\"\"\n attrs.update(self.attrs)\n attrs.update(self.add_markdownx_attrs(attrs))\n\n return super(MarkdownxWidget, self).render(name, value, attrs, renderer)\n\n @staticmethod\n def add_markdownx_attrs(attrs):\n \"\"\"\n Setting (X)HTML node attributes.\n\n :param attrs: Attributes to be set.\n :type attrs: dict\n :return: Dictionary of attributes, including the default attributes.\n :rtype: dict\n \"\"\"\n if 'class' in attrs.keys():\n if 'markdownx-editor' not in attrs['class']:\n attrs['class'] += ' markdownx-editor'\n else:\n attrs.update({\n 'class': 'markdownx-editor'\n })\n\n attrs.update({\n 'data-markdownx-editor-resizable': '%s' % MARKDOWNX_EDITOR_RESIZABLE,\n 'data-markdownx-urls-path': MARKDOWNX_URLS_PATH,\n 'data-markdownx-upload-urls-path': MARKDOWNX_UPLOAD_URLS_PATH,\n 'data-markdownx-latency': MARKDOWNX_SERVER_CALL_LATENCY\n })\n\n return attrs\n\n class Media:\n js = [\n 'markdownx/js/markdownx{}.js'.format(minified),\n ]\n\n\nclass AdminMarkdownxWidget(MarkdownxWidget, widgets.AdminTextareaWidget):\n \"\"\"\n MarkdownX TextArea widget for admin. Markdown enabled version of\n Django \"TextArea\" widget.\n \"\"\"\n\n class Media:\n css = {\n 'all': ['markdownx/admin/css/markdownx{}.css'.format(minified)]\n }\n\n js = [\n 'markdownx/js/markdownx{}.js'.format(minified),\n ]\n"
},
{
"path": "mkdocs.yml",
"content": "site_name: Django Markdownx\nsite_url: https://neutronx.github.io/django-markdownx/\nrepo_url: https://github.com/neutronX/django-markdownx/\nedit_uri: ''\nnav:\n - Django MarkdownX: index.md\n - Installation: installation.md\n - Getting Started: getting_started.md\n - Example: example.md\n - Customization: customization.md\n - JavaScript: javascript.md\n - Translations: translations.md\n - Contributions: contributions.md\n - License: license.md\ntheme:\n name: readthedocs\n hljs_languages:\n - bash\n - django\ndocs_dir: docs-src\nsite_dir: docs\nuse_directory_urls: true\ndev_addr: 0.0.0.0:8001\nexclude_docs: requirements.txt\nmarkdown_extensions:\n - toc:\n permalink: True\n - admonition\n - pymdownx.superfences\n"
},
{
"path": "requirements.txt",
"content": "Django\nPillow\nMarkdown\n"
},
{
"path": "setup.cfg",
"content": "[bdist_wheel]\nuniversal = 1\n"
},
{
"path": "setup.py",
"content": "\"\"\"\nInstallation\n============\nUsing PIP\n---------\nDjango MarkdownX may be installed directly using Python Package Index (PyPi):\n\n.. code-block:: bash\n\n python3 -m pip install django-markdownx\n\n\nFrom the source\n---------------\nShould you wish to download and install it using the source code, you can do as follows:\n\nNote\n Make sure you have activated your virtual environment if you're using one.\n\nWe start off by downloading the source code from GitHub and navigate to the downloaded directory:\n\n.. code-block:: bash\n\n git clone https://github.com/adi-/django-markdownx.git\n cd django-markdownx/\n\n\nInstall the package. You can replace ``python3`` with ``python`` or any of |Supported_versions_of_Python| if\nyou have multiple versions installed on your machine:\n\n.. code-block:: bash\n\n python3 setup.py install\n\n\n.. |Supported_versions_of_Python| image:: https://img.shields.io/pypi/pyversions/django-markdownx.svg\n\n\"\"\"\n\nfrom setuptools import setup\nfrom os import environ, link\nfrom os.path import join, dirname\n\n\nif 'vagrant' in str(environ):\n del link\n\n\ndef get_meta():\n from sys import version_info\n\n keys = {\n '__description__',\n '__credits__',\n '__copyright__',\n '__license__',\n '__maintainer__',\n '__url__',\n '__version__'\n }\n\n path = join(dirname(__file__), 'markdownx', '__init__.py')\n\n from importlib.util import spec_from_file_location, module_from_spec\n spec = spec_from_file_location('.', path)\n mod = module_from_spec(spec)\n spec.loader.exec_module(mod)\n\n meta = {key.replace('__', ''): getattr(mod, key) for key in keys}\n\n return meta\n\n\ndef get_requirements():\n with open('requirements.txt') as requirements:\n req = requirements.read().splitlines()\n return req\n\ndef readme():\n with open('README.md') as f:\n return f.read()\n\n\nmetadata = get_meta()\n\nsetup(\n name='django-markdownx',\n version=metadata.get('version'),\n packages=['markdownx', 'markdownx.tests'],\n maintainer=metadata.get('maintainer'),\n include_package_data=True,\n description=metadata.get('description'),\n long_description=readme(),\n long_description_content_type='text/markdown',\n url=metadata.get('url'),\n license=metadata.get('license'),\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'Environment :: Web Environment',\n 'Environment :: Plugins',\n 'Framework :: Django :: 4.2',\n 'Framework :: Django :: 5.0',\n 'Framework :: Django :: 5.1',\n 'Framework :: Django :: 5.2',\n 'Intended Audience :: Developers',\n 'License :: OSI Approved :: BSD License',\n 'Operating System :: OS Independent',\n 'Programming Language :: JavaScript',\n \"Programming Language :: Python\",\n 'Programming Language :: Python :: 3.10',\n 'Programming Language :: Python :: 3.11',\n 'Programming Language :: Python :: 3.12',\n 'Programming Language :: Python :: 3.13',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Multimedia :: Graphics',\n 'Topic :: Text Processing :: Markup',\n 'Topic :: Text Editors :: Text Processing',\n 'Topic :: Text Editors :: Word Processors',\n 'Topic :: Text Processing :: Markup :: HTML',\n 'Topic :: Multimedia :: Graphics :: Presentation',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Internet :: WWW/HTTP :: Site Management'\n ],\n keywords='django markdown markdownx django-markdownx editor image upload drag&drop ajax',\n tests_require=get_requirements(),\n test_suite='runtests',\n install_requires=get_requirements(),\n)\n"
},
{
"path": "static-src/markdownx/admin/css/markdownx.css",
"content": "/**\ndjango-markdownx styles for Django Admin\n**/\n.markdownx {\n display: inline-block;\n}\n.markdownx .markdownx-editor,\n.markdownx .markdownx-preview {\n margin-left: 0;\n width: 610px;\n box-sizing: border-box;\n}\n.markdownx .markdownx-preview {\n overflow-y: scroll;\n}\n\n\n/* Django admin overrides */\n\n.markdownx .markdownx-preview a { color: var(--link-fg); text-decoration:underline; }\n.markdownx .markdownx-preview a:visited { color: var(--link-selected-fg); }\n.markdownx .markdownx-preview a:hover { color: var(--link-hover-color); }\n.markdownx .markdownx-preview a:active { color: var(--link-selected-fg); }\n.markdownx .markdownx-preview a:focus { outline: thin dotted; }\n.markdownx .markdownx-preview a:hover, .markdownx .markdownx-preview a:active { outline: 0; }\n.markdownx .markdownx-preview p {\n margin: 1em 0;\n padding: 0;\n font-size: 14px;\n}\n.markdownx .markdownx-preview h1,\n.markdownx .markdownx-preview h2,\n.markdownx .markdownx-preview h3,\n.markdownx .markdownx-preview h4,\n.markdownx .markdownx-preview h5,\n.markdownx .markdownx-preview h6 {\n font-weight: bold;\n color: var(--body-fg);\n margin-top: 1em;\n margin-bottom: 0.75em;\n padding: 0;\n background: none;\n}\n.markdownx .markdownx-preview h1 { font-size: 2em; }\n.markdownx .markdownx-preview h2 { font-size: 1.7em; }\n.markdownx .markdownx-preview h3 { font-size: 1.4em; }\n.markdownx .markdownx-preview h4 { font-size: 1.2em; }\n.markdownx .markdownx-preview h5 { font-size: 1em; }\n.markdownx .markdownx-preview h6 { font-size: 0.9em; }\n\n.markdownx .markdownx-preview blockquote {\n color: var(--body-quiet-color);\n margin: 0;\n padding-left: 1.5em;\n font-style: italic;\n border-left: 0.5em solid var(--hairline-color);\n}\n.markdownx .markdownx-preview hr { margin: 20px 0; }\n.markdownx .markdownx-preview pre,\n.markdownx .markdownx-preview code,\n.markdownx .markdownx-preview kbd,\n.markdownx .markdownx-preview samp {\n font-family: monospace, monospace;\n font-size: 14px;\n}\n.markdownx .markdownx-preview code,\n.markdownx .markdownx-preview pre {\n margin: 0 2px;\n padding: 0 5px;\n background-color: var(--hairline-color);\n border-radius: 4px;\n color: var(--body-quiet-color);\n}\n.markdownx .markdownx-preview pre {\n margin: 1.5em 0 1.5em 0;\n padding: 1em;\n white-space: pre;\n white-space: pre-wrap;\n word-wrap: break-word;\n}\n.markdownx .markdownx-preview pre code {\n margin: 0;\n padding: 0;\n background: transparent;\n border: none;\n}\n.markdownx .markdownx-preview b,\n.markdownx .markdownx-preview strong { font-weight: bold; }\n.markdownx .markdownx-preview dfn { font-style: italic; }\n.markdownx .markdownx-preview ins { background: var(--message-success-bg); color: var(--body-fg); text-decoration: none; }\n.markdownx .markdownx-preview mark { background: var(--message-error-bg); color: var(--body-fg); font-style: italic; font-weight: bold; }\n.markdownx .markdownx-preview sub,\n.markdownx .markdownx-preview sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; }\n.markdownx .markdownx-preview sup { top: -0.5em; }\n.markdownx .markdownx-preview sub { bottom: -0.25em; }\n.markdownx .markdownx-preview ul,\n.markdownx .markdownx-preview ol { margin: .5em 0; padding: 0 0 0 2em !important; }\n.markdownx .markdownx-preview ul,\n.markdownx .markdownx-preview ul li,\n.markdownx .markdownx-preview ul ul li { list-style: disc !important; }\n.markdownx .markdownx-preview li p:last-child { margin:0; }\n.markdownx .markdownx-preview dd { margin: 0 0 0 2em; }\n.markdownx .markdownx-preview img { border: 0; -ms-interpolation-mode: bicubic; vertical-align: middle; max-width:100%; }\n.markdownx .markdownx-preview table { border-collapse: collapse; border-spacing: 0; }\n"
},
{
"path": "static-src/markdownx/js/markdownx.ts",
"content": "/**\n * **Markdownx**\n *\n * Frontend (JavaScript) management of Django-MarkdownX package.\n *\n * Written in JavaScript ECMA 2016, trans-compiled to ECMA 5 (2011).\n *\n * Requirements:\n * - Modern browser with support for HTML5 and ECMA 2011+ (IE 10+). Older browsers would work but some\n * features may be missing\n * - TypeScript 2 +\n *\n * JavaScript ECMA 5 files formatted as `.js` are trans-compiled files. Please do not edit such files as all\n * changes will be lost. Please modify `.ts` stored in `django-markdownx/static-src/markdownx/js/` directory.\n *\n * @Copyright 2017 - Adi, Pouria Hadjibagheri.\n */\n\n// Import, definitions and constant ------------------------------------------------------------------------------------\n\n\"use strict\";\n\ndeclare function docReady(args: any): any;\n\ninterface ImageUploadResponse {\n image_code?: string,\n image_path?: string,\n [propName: string]: any;\n}\n\ninterface HandlerFunction {\n (properties: {\n start: number,\n end: number,\n value: string\n }): string\n}\n\ninterface KeyboardEvents {\n keys: {\n TAB: string,\n DUPLICATE: string,\n UNINDENT: string,\n INDENT: string\n },\n handlers: {\n _multiLineIndentation: HandlerFunction,\n applyTab: HandlerFunction,\n applyIndentation: HandlerFunction,\n removeIndentation: HandlerFunction,\n removeTab: HandlerFunction,\n applyDuplication: HandlerFunction\n },\n hub: Function\n}\n\ninterface EventHandlers {\n inhibitDefault: Function,\n onDragEnter: Function\n}\n\ninterface MarkdownxProperties {\n parent: HTMLElement,\n editor: HTMLTextAreaElement,\n preview: HTMLElement,\n _latency: number | null,\n _editorIsResizable: Boolean | null\n}\n\nimport {\n Request,\n mountEvents,\n triggerEvent,\n preparePostData,\n triggerCustomEvent\n} from \"./utils\";\n\nconst UPLOAD_URL_ATTRIBUTE: string = \"data-markdownx-upload-urls-path\",\n PROCESSING_URL_ATTRIBUTE: string = \"data-markdownx-urls-path\",\n RESIZABILITY_ATTRIBUTE: string = \"data-markdownx-editor-resizable\",\n LATENCY_ATTRIBUTE: string = \"data-markdownx-latency\",\n LATENCY_MINIMUM: number = 500, // microseconds.\n XHR_RESPONSE_ERROR: string = \"Invalid response\",\n UPLOAD_START_OPACITY: string = \"0.3\",\n NORMAL_OPACITY: string = \"1\";\n\n// ---------------------------------------------------------------------------------------------------------------------\n\n\n/**\n *\n */\nconst EventHandlers: EventHandlers = {\n\n /**\n * Routine tasks for event handlers (e.g. default preventions).\n *\n * @param {Event} event\n * @returns {Event}\n */\n inhibitDefault: function (event: Event | KeyboardEvent): any {\n\n event.preventDefault();\n event.stopPropagation();\n\n return event\n\n },\n\n /**\n *\n * @param {DragEvent} event\n * returns {Event}\n */\n onDragEnter: function (event: DragEvent): Event {\n\n event.dataTransfer.dropEffect = 'copy';\n\n return EventHandlers.inhibitDefault(event)\n\n }\n\n};\n\n\n/**\n *\n */\nconst keyboardEvents: KeyboardEvents = {\n\n /**\n * Custom hotkeys.\n */\n keys: {\n TAB: \"Tab\",\n DUPLICATE: \"d\",\n UNINDENT: \"[\",\n INDENT: \"]\"\n },\n\n /**\n * Hotkey response functions.\n */\n handlers: {\n\n /**\n * Smart application of tab indentations under various conditions.\n *\n * @param {JSON} properties\n * @returns {string}\n */\n applyTab: function (properties) {\n\n // Do not replace with variables; this\n // feature is optimised for swift response.\n return properties.value\n .substring(0, properties.start) + // Preceding text.\n (\n properties.value\n .substring(properties.start, properties.end) // Selected text\n .match(/\\n/gm) === null ? // Not multi line?\n `\\t${properties.value.substring(properties.start)}` : // Add `\\t`.\n properties.value // Otherwise:\n .substring(properties.start, properties.end)\n .replace(/^/gm, '\\t') + // Add `\\t` to be beginning of each line.\n properties.value.substring(properties.end) // Succeeding text.\n )\n\n },\n\n /**\n * Smart removal of tab indentations.\n *\n * @param {JSON} properties\n * @returns {string}\n */\n removeTab: function (properties) {\n\n let substitution: string = null,\n lineTotal: number = (\n properties.value\n .substring(\n properties.start,\n properties.end\n ).match(/\\n/g) || [] // Number of lines (\\n) or empty array (zero).\n ).length; // Length of the array is equal to the number of lines.\n\n if (properties.start === properties.end) {\n\n // Replacing `\\t` at a specific location\n // (+/- 1 chars) where there is no selection.\n properties.start =\n properties.start > 0 &&\n properties.value[properties.start - 1] // -1 is to account any tabs just before the cursor.\n .match(/\\t/) !== null ? // if there's no `\\t`, check the preceding character.\n properties.start - 1 : properties.start;\n\n substitution = properties.value\n .substring(properties.start)\n .replace(\"\\t\", ''); // Remove only a single `\\t`.\n\n } else if (!lineTotal) {\n\n // Replacing `\\t` within a single line selection.\n substitution =\n properties.value\n .substring(properties.start)\n .replace(\"\\t\", '')\n\n } else {\n\n // Replacing `\\t` in the beginning of each line\n // in a multi-line selection.\n substitution =\n properties.value.substring(\n properties.start,\n properties.end\n ).replace(/^\\t/gm, '') + // Selection.\n properties.value.substring(properties.end); // After the selection\n\n }\n\n return properties.value\n .substring(0, properties.start) + // Text preceding to selection / cursor.\n substitution\n\n },\n\n /**\n * Handles multi line indentations.\n *\n * @param {JSON} properties\n * @returns {string}\n * @private\n */\n _multiLineIndentation: function (properties) {\n\n // Last line in the selection; regardless of\n // where of not the entire line is selected.\n const endLine: string =\n new RegExp(`(?:\\n|.){0,${properties.end}}(^.*$)`, \"m\")\n .exec(properties.value)[1];\n\n // Do not replace with variables; this\n // feature is optimised for swift response.\n return properties.value.substring(\n // First line of the selection, regardless of\n // whether or not the entire line is selected.\n properties.value.indexOf(\n new RegExp(`(?:\\n|.){0,${properties.start}}(^.*$)`, \"m\")\n .exec(properties.value)[1] // Start line.\n ), (\n // If there is a last line in a multi line selected\n // value where the last line is not empty or `\\n`:\n properties.value.indexOf(endLine) ?\n // Location where the last line finishes with\n // respect to the entire value.\n properties.value.indexOf(endLine) + endLine.length :\n // Otherwise, where the selection ends.\n properties.end\n )\n );\n\n },\n\n /**\n * Smart application of indentation at the beginning of the line.\n *\n * @param {JSON} properties\n * @returns {string}\n */\n applyIndentation: function (properties) {\n\n // Single line?\n if (properties.start === properties.end) {\n // Current line, from the beginning to the end, regardless of any selections.\n const line: string =\n new RegExp(`(?:\\n|.){0,${properties.start}}(^.+$)`, \"m\")\n .exec(properties.value)[1];\n\n return properties.value.replace(line, `\\t${line}`)\n }\n\n // Multi line\n const content: string = keyboardEvents.handlers._multiLineIndentation({\n start: properties.start,\n end: properties.end,\n value: properties.value\n });\n\n return properties.value\n .replace(\n content, // Existing contents.\n content.replace(/(^.+$)\\n*/gmi, \"\\t$&\") // Indented contents.\n )\n\n },\n\n /**\n * Smart removal of indentation from the beginning of the line.\n *\n * @param {JSON} properties\n * @returns {string}\n */\n removeIndentation: function (properties) {\n\n // Single Line\n if (properties.start === properties.end) {\n // Entire line where the line immediately begins\n // with a one or more `\\t`, regardless of any\n // selections.\n const line: string =\n new RegExp(`(?:\\n|.){0,${properties.start}}(^\\t.+$)`, \"m\")\n .exec(properties.value)[1];\n\n return properties.value\n .replace(\n line, // Existing content.\n line.substring(1) // First character (necessarily a `\\t`) removed.\n )\n }\n\n // Multi line\n const content: string = keyboardEvents.handlers._multiLineIndentation({\n start: properties.start,\n end: properties.end,\n value: properties.value\n });\n\n return properties.value\n .replace(\n content, // Existing content.\n content.replace(/^\\t(.+)\\n*$/gmi, \"$1\") // A single `\\t` removed from the beginning.\n )\n\n },\n\n /**\n * Duplication of the current or selected lines.\n *\n * @param {JSON} properties\n * @returns {string}\n */\n applyDuplication: function (properties) {\n\n // With selection.\n // Do not replace with variables. This\n // feature is optimised for swift response.\n if (properties.start !== properties.end)\n return (\n properties.value.substring( // Text preceding the selected area.\n 0,\n properties.start\n ) +\n properties.value.substring( // Selected area\n properties.start,\n properties.end\n ) +\n (\n ~properties.value // First character before the cursor is linebreak?\n .charAt(properties.start - 1)\n .indexOf('\\n') || // --> or\n ~properties.value // Character on the cursor is linebreak?\n .charAt(properties.start)\n .indexOf('\\n') ? '\\n' : '' // If either, add linebreak, otherwise add nothing.\n ) +\n properties.value.substring( // Selected area (again for duplication).\n properties.start,\n properties.end\n ) +\n properties.value.substring(properties.end) // Text succeeding the selected area.\n );\n\n // Without selection.\n let pattern: RegExp = // Separate lines up to the end of the current line.\n new RegExp(`(?:.|\\n){0,160}(^.*$)`, 'm'),\n line: string = '';\n\n // Add anything found to the `line`. Note that\n // `replace` is used a simple hack; it functions\n // in a similar way to `regex.search` in Python.\n properties.value\n .replace(pattern, (match, p1) => line += p1);\n\n return properties.value\n .replace(\n line, // Existing line.\n `${line}\\n${line}` // Doubled ... magic!\n )\n\n },\n\n },\n\n /**\n * Mapping of hotkeys from keyboard events to their corresponding functions.\n *\n * @param {KeyboardEvent} event\n * @returns {Function | Boolean}\n */\n hub: function (event: KeyboardEvent): Function | false {\n\n switch (event.key) {\n case this.keys.TAB: // Tab.\n // Shift pressed: un-indent, otherwise indent.\n return event.shiftKey ? this.handlers.removeTab : this.handlers.applyTab;\n\n case this.keys.DUPLICATE: // Line duplication.\n // Is CTRL or CMD (on Mac) pressed?\n return (event.ctrlKey || event.metaKey) ? this.handlers.applyDuplication : false;\n\n case this.keys.INDENT: // Indentation.\n // Is CTRL or CMD (on Mac) pressed?\n return (event.ctrlKey || event.metaKey) ? this.handlers.applyIndentation : false;\n\n case this.keys.UNINDENT: // Unindentation.\n // Is CTRL or CMD (on Mac) pressed?\n return (event.ctrlKey || event.metaKey) ? this.handlers.removeIndentation : false;\n\n default:\n // default would prevent the\n // inhibition of default settings.\n return false\n }\n\n }\n\n};\n\n\n/**\n * Get either the height of an element as defined in style/CSS or its browser-computed height.\n *\n * @param {HTMLElement} element\n * @returns {number}\n */\nfunction getHeight (element: HTMLElement): number {\n\n return Math.max( // Maximum of computed or set heights.\n parseInt(window.getComputedStyle(element).height), // Height is not set in styles.\n (parseInt(element.style.height) || 0) // Property's own height if set, otherwise 0.\n )\n\n}\n\n\n/**\n * Update the height of an element based on its scroll height.\n *\n * @param {HTMLTextAreaElement} editor\n * @returns {HTMLTextAreaElement}\n */\nfunction updateHeight(editor: HTMLTextAreaElement): HTMLTextAreaElement {\n\n // Ensure that the editor is resizable before anything else.\n // Change size if scroll is larger that height, otherwise do nothing.\n\n editor.style.height = `${editor.scrollHeight + parseInt(getComputedStyle(editor).borderTop) + parseInt(getComputedStyle(editor).borderBottom)}px`;\n\n return editor\n\n}\n\n\n/**\n * @example\n *\n * let element = document.getElementsByClassName('markdownx');\n *\n * new MarkdownX(\n * element,\n * element.querySelector('.markdownx-editor'),\n * element.querySelector('.markdownx-preview')\n * )\n *\n * @param {HTMLElement} parent - Markdown editor element.\n * @param {HTMLTextAreaElement} editor - Markdown editor element.\n * @param {HTMLElement} preview - Markdown preview element.\n */\nconst MarkdownX = function (parent: HTMLElement, editor: HTMLTextAreaElement, preview: HTMLElement): void {\n\n /**\n * MarkdownX properties.\n */\n const properties: MarkdownxProperties = {\n\n editor: editor,\n preview: preview,\n parent: parent,\n _latency: null,\n _editorIsResizable: null\n\n };\n\n /**\n * Initialisation settings (mounting events, retrieval of initial data,\n * setting animation properties, latency, timeout, and resizability).\n *\n * @private\n */\n const _initialize = () => {\n\n this.timeout = null;\n\n // Events\n // ----------------------------------------------------------------------------------------------\n let documentListeners = {\n object: document,\n listeners: [\n { type: \"drop\" , capture: false, listener: EventHandlers.inhibitDefault },\n { type: \"dragover\" , capture: false, listener: EventHandlers.inhibitDefault },\n { type: \"dragenter\", capture: false, listener: EventHandlers.inhibitDefault },\n { type: \"dragleave\", capture: false, listener: EventHandlers.inhibitDefault }\n ]\n },\n editorListeners = {\n object: properties.editor,\n listeners: [\n { type: \"paste\", capture: false, listener: onPaste },\n { type: \"drop\", capture: false, listener: onDrop },\n { type: \"input\", capture: true , listener: inputChanged },\n { type: \"keydown\", capture: true , listener: onKeyDown },\n { type: \"focusin\", capture: true , listener: inputChanged },\n { type: \"dragover\", capture: false, listener: EventHandlers.onDragEnter },\n { type: \"dragenter\", capture: false, listener: EventHandlers.onDragEnter },\n { type: \"dragleave\", capture: false, listener: EventHandlers.inhibitDefault },\n { type: \"compositionstart\", capture: true , listener: onKeyDown }\n ]\n };\n\n // Initialise\n // --------------------------------------------------------\n\n // Mounting the defined events.\n mountEvents(editorListeners, documentListeners);\n\n properties.editor.setAttribute('data-markdownx-init', '');\n\n // Set animation for image uploads lock down.\n properties.editor.style.transition = \"opacity 1s ease\";\n properties.editor.style.webkitTransition = \"opacity 1s ease\";\n\n // Upload latency - must be a value >= 500 microseconds.\n properties._latency =\n Math.max(parseInt(properties.editor.getAttribute(LATENCY_ATTRIBUTE)) || 0, LATENCY_MINIMUM);\n\n // If `true`, the editor will expand to scrollHeight when needed.\n properties._editorIsResizable = (\n (properties.editor.getAttribute(RESIZABILITY_ATTRIBUTE).match(/true/i) || []).length > 0 &&\n properties.editor.offsetHeight > 0 &&\n properties.editor.offsetWidth > 0\n );\n\n getMarkdown();\n\n triggerCustomEvent(\"markdownx.init\");\n\n };\n\n /**\n * settings for `timeout`.\n *\n * @private\n */\n const _markdownify = (): void => {\n\n clearTimeout(this.timeout);\n this.timeout = setTimeout(getMarkdown, properties._latency)\n\n };\n\n /**\n * Handling changes in the editor.\n */\n const inputChanged = (): void => {\n\n properties.editor = properties._editorIsResizable ?\n updateHeight(properties.editor) : properties.editor;\n\n return _markdownify()\n\n };\n\n /**\n * Handling of paste event.\n *\n * @param {ClipboardEvent} event\n */\n const onPaste = (event: ClipboardEvent): void => {\n\n if (event.clipboardData && event.clipboardData.files.length) {\n Object.keys(event.clipboardData.files).map(fileKey =>\n\n sendFile(event.clipboardData.files[fileKey])\n\n );\n EventHandlers.inhibitDefault(event);\n }\n\n };\n\n /**\n * Handling of drop events (when a file is dropped into `properties.editor`).\n *\n * @param {DragEvent} event\n */\n const onDrop = (event: DragEvent): void => {\n\n if (event.dataTransfer && event.dataTransfer.files.length)\n Object.keys(event.dataTransfer.files).map(fileKey =>\n\n sendFile(event.dataTransfer.files[fileKey])\n\n );\n\n EventHandlers.inhibitDefault(event);\n\n };\n\n /**\n * Handling of keyboard events (i.e. primarily hotkeys).\n *\n * @param {KeyboardEvent} event\n * @returns {Boolean | null}\n */\n const onKeyDown = (event: KeyboardEvent): Boolean | null => {\n\n const handlerFunc: Function | Boolean = keyboardEvents.hub(event);\n\n if (typeof handlerFunc != 'function') return false;\n\n EventHandlers.inhibitDefault(event);\n\n // Holding the start location before anything changes.\n const SELECTION_START: number = properties.editor.selectionStart;\n\n properties.editor.value = handlerFunc({\n start: properties.editor.selectionStart,\n end: properties.editor.selectionEnd,\n value: properties.editor.value\n });\n\n _markdownify();\n\n properties.editor.focus();\n\n // Set the cursor location.\n switch (event.key) {\n case keyboardEvents.keys.TAB: // Tab.\n if (event.shiftKey) {\n properties.editor.selectionEnd = properties.editor.selectionStart = SELECTION_START - 1\n }\n else {\n properties.editor.selectionEnd = properties.editor.selectionStart = SELECTION_START + 1\n }\n break\n\n case keyboardEvents.keys.INDENT: // Indentation.\n properties.editor.selectionEnd = properties.editor.selectionStart = SELECTION_START + 1\n break\n\n case keyboardEvents.keys.UNINDENT: // Unindentation.\n properties.editor.selectionEnd = properties.editor.selectionStart = SELECTION_START - 1\n break\n\n default:\n properties.editor.selectionEnd = properties.editor.selectionStart = SELECTION_START\n }\n\n return false\n\n };\n\n /**\n * Uploading the `file` onto the server through an AJAX request.\n *\n * @param {File} file\n */\n const sendFile = (file: File) => {\n\n properties.editor.style.opacity = UPLOAD_START_OPACITY;\n\n const xhr = new Request(\n properties.editor.getAttribute(UPLOAD_URL_ATTRIBUTE), // URL\n preparePostData({image: file}) // Data\n );\n\n xhr.success = (resp: string): void | null => {\n\n const response: ImageUploadResponse = JSON.parse(resp);\n\n if (response.image_code) {\n\n insertImage(response.image_code);\n triggerCustomEvent('markdownx.fileUploadEnd', properties.parent, [response])\n\n } else if (response.image_path) {\n\n // ToDo: Deprecate.\n insertImage(`![](\"${response.image_path}\")`);\n triggerCustomEvent('markdownx.fileUploadEnd', properties.parent, [response])\n\n } else {\n\n console.error(XHR_RESPONSE_ERROR, response);\n triggerCustomEvent('markdownx.fileUploadError', properties.parent, [response]);\n insertImage(XHR_RESPONSE_ERROR);\n\n }\n\n properties.editor.style.opacity = NORMAL_OPACITY;\n\n };\n\n xhr.error = (response: any): void => {\n\n console.error(response);\n triggerCustomEvent('fileUploadError', properties.parent, [response]);\n insertImage(XHR_RESPONSE_ERROR);\n properties.editor.style.opacity = NORMAL_OPACITY;\n\n };\n\n return xhr.send()\n\n };\n\n /**\n * Uploading the markdown text from `properties.editor` onto the server\n * through an AJAX request, and upon receiving the HTML encoded text\n * in response, the response will be display in `properties.preview`.\n */\n const getMarkdown = () => {\n\n const xhr = new Request(\n properties.editor.getAttribute(PROCESSING_URL_ATTRIBUTE), // URL\n preparePostData({content: properties.editor.value}) // Data\n );\n\n xhr.success = (response: string): void => {\n\n properties.preview.innerHTML = response;\n properties.editor = properties._editorIsResizable ?\n updateHeight(properties.editor) : properties.editor;\n\n triggerCustomEvent('markdownx.update', properties.parent, [response])\n\n };\n\n xhr.error = (response: any): void => {\n\n console.error(response);\n\n triggerCustomEvent('markdownx.updateError', properties.parent, [response])\n\n };\n\n return xhr.send()\n\n };\n\n /**\n * Inserts markdown encoded image URL into `properties.editor` where\n * the cursor is located.\n *\n * @param textToInsert\n */\n const insertImage = (textToInsert: string): void => {\n\n properties.editor.value =\n `${properties.editor.value.substring(0, properties.editor.selectionStart)}` + // Preceding text.\n textToInsert +\n `${properties.editor.value.substring(properties.editor.selectionEnd)}`; // Succeeding text.\n\n properties.editor.selectionStart =\n properties.editor.selectionEnd =\n properties.editor.selectionStart + textToInsert.length;\n\n triggerEvent(properties.editor, 'keyup');\n inputChanged();\n\n };\n\n\n _initialize();\n\n};\n\n\n(function(funcName: any, baseObj: any) {\n // The public function name defaults to window.docReady\n // but you can pass in your own object and own function\n // name and those will be used.\n // if you want to put them in a different namespace\n funcName = funcName || \"docReady\";\n baseObj = baseObj || window;\n\n let readyList = [],\n readyFired = false,\n readyEventHandlersInstalled = false;\n\n /**\n * Called when the document is ready. This function protects itself\n * against being called more than once.\n */\n const ready = () => {\n if (!readyFired) {\n // Must be `true` before the callbacks are called.\n readyFired = true;\n\n // if a callback here happens to add new ready handlers,\n // the docReady() function will see that it already fired\n // and will schedule the callback to run right after\n // this event loop finishes so all handlers will still execute\n // in order and no new ones will be added to the readyList\n // while we are processing the list\n readyList.map(ready => ready.fn.call(window, ready.ctx));\n\n // allow any closures held by these functions to free\n readyList = [];\n }\n };\n\n const readyStateChange = () => document.readyState === \"complete\" ? ready() : null;\n\n // This is the one public interface\n // docReady(fn, context);\n // the context argument is optional - if present, it will be passed\n // as an argument to the callback\n baseObj[funcName] = (callback, context) => {\n\n // if ready has already fired, then just schedule the callback\n // to fire asynchronously, but right away\n if (readyFired) {\n\n setTimeout(() => callback(context), 1);\n return;\n\n } else {\n\n // add the function and context to the list\n readyList.push({fn: callback, ctx: context});\n\n }\n\n // If the document is already ready, schedule the ready\n // function to run.\n if (document.readyState === \"complete\") {\n\n setTimeout(ready, 1);\n\n } else if (!readyEventHandlersInstalled) {\n\n // otherwise if we don't have event handlers installed,\n // install them first choice is DOMContentLoaded event.\n document.addEventListener(\"DOMContentLoaded\", ready, false);\n\n // backup is window load event\n window.addEventListener(\"load\", ready, false);\n\n readyEventHandlersInstalled = true;\n\n }\n }\n\n})(\"docReady\", window);\n\n\ndocReady(() => {\n\n const ELEMENTS = document.getElementsByClassName('markdownx');\n\n return Object.keys(ELEMENTS).map(key => {\n\n let element = ELEMENTS[key],\n editor = element.querySelector('.markdownx-editor'),\n preview = element.querySelector('.markdownx-preview');\n\n // Only add the new MarkdownX instance to fields that have no MarkdownX instance yet.\n if (!editor.hasAttribute('data-markdownx-init'))\n return new MarkdownX(element, editor, preview)\n\n });\n\n});\n\n\nexport {\n\n MarkdownX\n\n};\n"
},
{
"path": "static-src/markdownx/js/tsconfig.json",
"content": "{\n \"compilerOptions\": {\n \"moduleResolution\": \"node\",\n \"inlineSourceMap\": false,\n \"inlineSources\": false,\n \"emitDecoratorMetadata\": true,\n \"experimentalDecorators\": true,\n \"removeComments\": false,\n \"preserveConstEnums\": true,\n \"sourceMap\": true,\n \"module\": \"commonjs\",\n \"target\": \"es5\",\n \"pretty\": true,\n \"noLib\": false,\n \"emitBOM\": true,\n \"allowJs\": true\n },\n \"declaration\": true,\n \"files\": [\n \"markdownx.ts\"\n ]\n}\n"
},
{
"path": "static-src/markdownx/js/utils.ts",
"content": "\"use strict\";\n\ninterface EventListener {\n\n object: Element | Document,\n listeners: {\n type: string,\n listener: any,\n capture: boolean,\n } []\n\n}\n\n\nexport interface RequestBase {\n\n url: string;\n data: FormData;\n progress(event: any): any;\n error(response: string): any;\n success(response: string): any;\n send(): void;\n\n}\n\n\n/**\n * Looks for a cookie, and if found, returns the values.\n *\n * @param {string} name - The name of the cookie.\n * @returns {string | null}\n */\nexport function getCookie (name: string): string | null {\n\n if (document.cookie && document.cookie.length) {\n\n const value = `; ${document.cookie}`;\n const parts = value.split(`; ${name}=`);\n\n if (parts.length === 2) {\n\n try {\n return decodeURIComponent(parts.pop().split(';').shift());\n }\n catch (e) {\n if (e instanceof TypeError) {\n console.info(\"No cookie with key \\\"\" + name + \"\\\". Wrong name?\");\n return null;\n }\n throw e;\n }\n }\n }\n\n return null;\n\n}\n\n\n/**\n * @example\n *\n *\n * @param rows\n * @returns\n */\nexport function zip (...rows: any[]) {\n\n if (rows[0].constructor == Array)\n return [...rows[0]].map((_, c) => rows.map(row => row[c]));\n\n // ToDo: To be updated to Objects.values in ECMA2017 after the method is fully ratified.\n const asArray = rows.map(row => Object.keys(row).map(key => row[key]));\n\n return [...asArray[0]].map((_, c) => asArray.map(row => row[c]));\n\n}\n\n\n\n/**\n *\n * @param collections\n * @returns\n */\nexport function mountEvents (...collections: EventListener[]): any[] {\n\n return collections.map(events =>\n events.listeners\n .map(series =>\n events.object\n .addEventListener(\n series.type,\n series.listener,\n series.capture\n )\n )\n )\n\n}\n\n\n/**\n *\n * @param {JSON} data\n * @param {Boolean} csrf\n * @returns {FormData}\n */\nexport function preparePostData(data: Object, csrf: Boolean=true) {\n\n let form: FormData = new FormData();\n\n if (csrf) {\n let csrfToken = getCookie('csrftoken');\n if (!csrfToken) csrfToken = (