{"id":13418951,"url":"https://github.com/klen/django_markdown","last_synced_at":"2025-06-17T10:13:09.348Z","repository":{"id":56021878,"uuid":"1320319","full_name":"klen/django_markdown","owner":"klen","description":"Django markdown support and wysiwig","archived":false,"fork":false,"pushed_at":"2020-12-02T08:09:20.000Z","size":752,"stargazers_count":390,"open_issues_count":46,"forks_count":142,"subscribers_count":15,"default_branch":"develop","last_synced_at":"2025-06-09T12:48:48.330Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/klen.png","metadata":{"files":{"readme":"README.rst","changelog":"Changelog","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-02-02T13:21:57.000Z","updated_at":"2025-01-20T01:23:49.000Z","dependencies_parsed_at":"2022-08-15T11:40:12.346Z","dependency_job_id":null,"html_url":"https://github.com/klen/django_markdown","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/klen/django_markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klen%2Fdjango_markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klen%2Fdjango_markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klen%2Fdjango_markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klen%2Fdjango_markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klen","download_url":"https://codeload.github.com/klen/django_markdown/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klen%2Fdjango_markdown/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260336371,"owners_count":22993742,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T22:01:09.306Z","updated_at":"2025-06-17T10:13:04.334Z","avatar_url":"https://github.com/klen.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"Django-Markdown v. 0.8.4\n########################\n\n.. _description:\n\n**Django markdown** is django application that allows use markdown wysiwyg in flatpages, admin forms and other forms.\nDocumentaton available at pypi_ or github_.\n\n.. _badges:\n\n.. image:: http://img.shields.io/travis/klen/django_markdown.svg?style=flat-square\n    :target: http://travis-ci.org/klen/django_markdown\n    :alt: Build Status\n\n.. image:: http://img.shields.io/coveralls/klen/django_markdown.svg?style=flat-square\n    :target: https://coveralls.io/r/klen/django_markdown\n    :alt: Coverals\n\n.. image:: http://img.shields.io/pypi/v/django_markdown.svg?style=flat-square\n    :target: https://pypi.python.org/pypi/django_markdown\n    :alt: Version\n\n.. image:: http://img.shields.io/pypi/dm/django_markdown.svg?style=flat-square\n    :target: https://pypi.python.org/pypi/django_markdown\n    :alt: Downloads\n\n.. image:: http://img.shields.io/pypi/l/django_markdown.svg?style=flat-square\n    :target: https://pypi.python.org/pypi/django_markdown\n    :alt: License\n\n.. image:: http://img.shields.io/gratipay/klen.svg?style=flat-square\n    :target: https://www.gratipay.com/klen/\n    :alt: Donate\n\n.. contents::\n\n.. _requirements:\n\nRequirements\n============\n\n- python \u003e= 2.7\n- django \u003e= 1.6\n- markdown\n\n\n.. _installation:\n\nInstallation\n============\n\n**Django markdown** should be installed using pip: ::\n\n    pip install django-markdown\n\n\nSetup\n=====\n\n.. note:: 'django_markdown' require 'django.contrib.staticfiles' in INSTALLED_APPS\n\n- Add 'django_markdown' to INSTALLED_APPS ::\n\n    INSTALLED_APPS += ( 'django_markdown', )\n\n\n- Add django_markdown urls to base urls ::\n\n    url('^markdown/', include( 'django_markdown.urls')),\n\n\nUse django_markdown\n===================\n\n#) Models: ::\n    \n    from django_markdown.models import MarkdownField\n    class MyModel(models.Model):\n        content = MarkdownField()\n\n#) Custom forms: ::\n\n    from django_markdown.fields import MarkdownFormField\n    from django_markdown.widgets import MarkdownWidget\n    class MyCustomForm(forms.Form):\n        content = forms.CharField(widget=MarkdownWidget())\n        content2 = MarkdownFormField()\n\n#) Custom admins: ::\n\n    from django_markdown.admin import MarkdownModelAdmin\n    admin.site.register(MyModel, MarkdownModelAdmin)\n\n#) Admin Overrides: (If you don't want to subclass package ModelAdmin's) ::\n\n    from django.contrib import admin\n\n    class YourModelAdmin(admin.ModelAdmin):\n        formfield_overrides = {MarkdownField: {'widget': AdminMarkdownWidget}}\n\n#) Flatpages: ::\n\n    # in your project main urls\n    from django_markdown import flatpages\n    ...\n    # Django admin\n    admin.autodiscover()\n    flatpages.register()\n    urlpatterns += [ url(r'^admin/', include(admin.site.urls)), ]\n\n#) Template tags: ::\n\n    \u003ctextarea name=\"test\" id=\"new\"\u003e\u003c/textarea\u003e\n    {% markdown_editor \"#new\" %}\n    {% markdown_media %}\n\n\nSettings\n========\n\n**MARKDOWN_EDITOR_SETTINGS** - holds the extra parameters set to be passed to ``textarea.markItUp()``\n\n**MARKDOWN_EDITOR_SKIN** - skin option, default value is ``markitup``\n\nExample: `settings.py` ::\n\n    MARKDOWN_EDITOR_SKIN = 'simple'\n\n**MARKDOWN_EXTENSIONS** - optional list of extensions passed to Markdown, discussed at https://pythonhosted.org/Markdown/extensions/index.html#officially-supported-extensions\n\nExample: `settings.py` ::\n\n    MARKDOWN_EXTENSIONS = ['extra']\n\n**MARKDOWN_EXTENSION_CONFIGS** - Configure extensions, discussed at https://pythonhosted.org/Markdown/reference.html#extension_configs\n\n**MARKDOWN_PREVIEW_TEMPLATE** - Template for preview a markdown. By default `django_markdown/preview.css`\n\n**MARKDOWN_STYLE** - path to preview styles. By default `django_markdown/preview.css`\n\n**MARKDOWN_SET_PATH** - path to folder with sets. By default `django_markdown/sets`\n\n**MARKDOWN_SET_NAME** - name for current set. By default `markdown`.\n\n**MARKDOWN_PROTECT_PREVIEW** - protect preview url for staff only\n\n\nExamples\n========\n\nExecute `make run` in sources directory. Open http://127.0.0.1:8000 in your\nbrowser. For admin access use 'root:root' credentials.\n\n\nChanges\n=======\n\nMake sure you`ve read the following document if you are upgrading from previous versions:\n\nhttp://packages.python.org/django-markdown/changes.html\n\n\nBug tracker\n===========\n\nIf you have any suggestions, bug reports or\nannoyances please report them to the issue tracker\nat https://github.com/klen/django_markdown/issues\n\n\nContributing\n============\n\nDevelopment of django-markdown happens at github: https://github.com/klen/django_markdown\n\n\nContributors\n=============\n\n* klen_ (Kirill Klenov)\n\n* yavorskiy_ (Sergii Iavorskyi)\n\n\nLicense\n=======\n\nLicensed under a `GNU lesser general public license`_.\n\n\nCopyright\n=========\n\nCopyright (c) 2011 Kirill Klenov (horneds@gmail.com)\n\nMarkitup_:\n    (c) 2008 Jay Salvat\n    http://markitup.jaysalvat.com/ \n    \n\n.. _GNU lesser general public license: http://www.gnu.org/copyleft/lesser.html\n.. _pypi: http://packages.python.org/django-markdown/\n.. _Markitup: http://markitup.jaysalvat.com/ \n.. _github: https://github.com/klen/django_markdown\n.. _klen: https://github.com/klen\n.. _yavorskiy: https://github.com/yavorskiy\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklen%2Fdjango_markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklen%2Fdjango_markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklen%2Fdjango_markdown/lists"}