django-markdownit

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

            # django-markdownit

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

## Installation

1. Install the package:

    ```bash
    poetry add django-markdownit
    ```
    or using pip:
    ```bash
    pip install django-markdownit
    ```

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-markdownit",
    "name": "django-markdownit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.12",
    "maintainer_email": null,
    "keywords": "django, markdown, commonmark",
    "author": "Richard",
    "author_email": "richard@stromer.org",
    "download_url": "https://files.pythonhosted.org/packages/59/63/090cc1e3aab2821bf9b6c15629289424df834e97a587be7bdb9ee4cd3b99/django_markdownit-0.5.0.tar.gz",
    "platform": null,
    "description": "# django-markdownit\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-markdownit\n    ```\n    or using pip:\n    ```bash\n    pip install django-markdownit\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.5.0",
    "project_urls": {
        "Homepage": "https://github.com/noxan/django-markdownit",
        "Repository": "https://github.com/noxan/django-markdownit"
    },
    "split_keywords": [
        "django",
        " markdown",
        " commonmark"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "183eaadab4b3b5573dcd9bc911f4e67c344805b5bc0efdde1261de6df93e6b7e",
                "md5": "623af41e378e65b6a122e741ee2b22c0",
                "sha256": "d78f1e4d4c680554902055fb8f36fd81709ec704139a3f936425e10b905b2678"
            },
            "downloads": -1,
            "filename": "django_markdownit-0.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "623af41e378e65b6a122e741ee2b22c0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.12",
            "size": 3382,
            "upload_time": "2024-09-01T10:39:52",
            "upload_time_iso_8601": "2024-09-01T10:39:52.712459Z",
            "url": "https://files.pythonhosted.org/packages/18/3e/aadab4b3b5573dcd9bc911f4e67c344805b5bc0efdde1261de6df93e6b7e/django_markdownit-0.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5963090cc1e3aab2821bf9b6c15629289424df834e97a587be7bdb9ee4cd3b99",
                "md5": "cc2ac11cadcb28c30413df1fb99170e5",
                "sha256": "df87c61727bac43d24733041624a35b2a10bdf6db29a6e00f941cfbde35b0746"
            },
            "downloads": -1,
            "filename": "django_markdownit-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "cc2ac11cadcb28c30413df1fb99170e5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.12",
            "size": 1933,
            "upload_time": "2024-09-01T10:39:54",
            "upload_time_iso_8601": "2024-09-01T10:39:54.078358Z",
            "url": "https://files.pythonhosted.org/packages/59/63/090cc1e3aab2821bf9b6c15629289424df834e97a587be7bdb9ee4cd3b99/django_markdownit-0.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-01 10:39:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "noxan",
    "github_project": "django-markdownit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "django-markdownit"
}