django-markdown-it

Name	django-markdown-it JSON
Version	0.4.1 JSON
	download
home_page	https://github.com/noxan/django-markdown-it
Summary	Markdown template filter for Django following CommonMark specs (markdown-it-py).
upload_time	2024-02-20 11:23:34
maintainer
docs_url	None
author	Richard
requires_python	>=3.12,<4.0
license	MIT
keywords	django markdown commonmark
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # django-markdown-it

Markdown template filter for Django following [CommonMark](https://commonmark.org/) specs.

## Installation

1. Install the package:

    ```bash
    poetry add django-markdown-it
    ```
    or using pip:
    ```bash
    pip install django-markdown-it
    ```

2. Add `markdownit` to your `INSTALLED_APPS`:

    ```python
    INSTALLED_APPS = [
        # ...
        'markdownit',
    ]
    ```

## Usage

1. Load the template tag library in your template:

    ```django
    {% load markdownit %}
    ```

2. Use the `markdownit` filter on a string:

    ```django
    {{ my_string|markdownit }}
    ```


## Credits

- Inspired by [django-markdownify](https://github.com/erwinmatijsen/django-markdownify/).
- Using [markdown-it-py](https://github.com/executablebooks/markdown-it-py) for Markdown rendering.
- Using [nh3](https://github.com/messense/nh3)/[ammonia](https://github.com/rust-ammonia/ammonia) for HTML sanitization.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/noxan/django-markdown-it",
    "name": "django-markdown-it",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.12,<4.0",
    "maintainer_email": "",
    "keywords": "django,markdown,commonmark",
    "author": "Richard",
    "author_email": "richard@stromer.org",
    "download_url": "https://files.pythonhosted.org/packages/be/de/6b8d3b2578d78d55be3dc7a9bde8e97b1d292db6955892b9bbf8607d2b9f/django_markdown_it-0.4.1.tar.gz",
    "platform": null,
    "description": "# django-markdown-it\n\nMarkdown template filter for Django following [CommonMark](https://commonmark.org/) specs.\n\n## Installation\n\n1. Install the package:\n\n    ```bash\n    poetry add django-markdown-it\n    ```\n    or using pip:\n    ```bash\n    pip install django-markdown-it\n    ```\n\n2. Add `markdownit` to your `INSTALLED_APPS`:\n\n    ```python\n    INSTALLED_APPS = [\n        # ...\n        'markdownit',\n    ]\n    ```\n\n## Usage\n\n1. Load the template tag library in your template:\n\n    ```django\n    {% load markdownit %}\n    ```\n\n2. Use the `markdownit` filter on a string:\n\n    ```django\n    {{ my_string|markdownit }}\n    ```\n\n\n## Credits\n\n- Inspired by [django-markdownify](https://github.com/erwinmatijsen/django-markdownify/).\n- Using [markdown-it-py](https://github.com/executablebooks/markdown-it-py) for Markdown rendering.\n- Using [nh3](https://github.com/messense/nh3)/[ammonia](https://github.com/rust-ammonia/ammonia) for HTML sanitization.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Markdown template filter for Django following CommonMark specs (markdown-it-py).",
    "version": "0.4.1",
    "project_urls": {
        "Homepage": "https://github.com/noxan/django-markdown-it",
        "Repository": "https://github.com/noxan/django-markdown-it"
    },
    "split_keywords": [
        "django",
        "markdown",
        "commonmark"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0b89bce8c4ded6bc95d736e833432f30f25cf0b5e9d619c951371fab3533d6a1",
                "md5": "4cdb6576c07316d991cfe3795128f1af",
                "sha256": "a3657109768f0b5f7dc774f122933f4c60f60a2eb042ede51042cc12738ab127"
            },
            "downloads": -1,
            "filename": "django_markdown_it-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4cdb6576c07316d991cfe3795128f1af",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12,<4.0",
            "size": 3395,
            "upload_time": "2024-02-20T11:23:33",
            "upload_time_iso_8601": "2024-02-20T11:23:33.503463Z",
            "url": "https://files.pythonhosted.org/packages/0b/89/bce8c4ded6bc95d736e833432f30f25cf0b5e9d619c951371fab3533d6a1/django_markdown_it-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bede6b8d3b2578d78d55be3dc7a9bde8e97b1d292db6955892b9bbf8607d2b9f",
                "md5": "2ae515c249f99d57ef86b7b5c71aa15a",
                "sha256": "44e9f5aff92994f098b2998e0cd18aef2657f780ee9d0cddb9f44de18599254a"
            },
            "downloads": -1,
            "filename": "django_markdown_it-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2ae515c249f99d57ef86b7b5c71aa15a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12,<4.0",
            "size": 2018,
            "upload_time": "2024-02-20T11:23:34",
            "upload_time_iso_8601": "2024-02-20T11:23:34.777098Z",
            "url": "https://files.pythonhosted.org/packages/be/de/6b8d3b2578d78d55be3dc7a9bde8e97b1d292db6955892b9bbf8607d2b9f/django_markdown_it-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-20 11:23:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "noxan",
    "github_project": "django-markdown-it",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "django-markdown-it"
}