{ "info": { "author": "Kirill Klenov", "author_email": "horneds@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)", "Natural Language :: English", "Natural Language :: Russian", "Programming Language :: Python", "Topic :: Software Development :: Code Generators", "Topic :: Text Processing :: Markup" ], "description": "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 >= 2.7\n- django >= 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 \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", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/klen/django_markdown", "keywords": "html markdown django", "license": "GNU LGPL", "maintainer": null, "maintainer_email": null, "name": "django-markdown-vinta", "package_url": "https://pypi.org/project/django-markdown-vinta/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/django-markdown-vinta/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/klen/django_markdown" }, "release_url": "https://pypi.org/project/django-markdown-vinta/0.8.4/", "requires_dist": null, "requires_python": null, "summary": "Django markdown support and wysiwyg.", "version": "0.8.4" }, "last_serial": 4134127, "releases": { "0.8.4": [ { "comment_text": "", "digests": { "md5": "27264e93d26cadf34b3cd2fb3ce60355", "sha256": "63d30635c7e61a78f4579ec53aaeab5b884978391dd69e09686edbb726db6603" }, "downloads": -1, "filename": "django-markdown-vinta-0.8.4.tar.gz", "has_sig": false, "md5_digest": "27264e93d26cadf34b3cd2fb3ce60355", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 73885, "upload_time": "2016-08-10T12:00:57", "url": "https://files.pythonhosted.org/packages/a8/82/ac0908b31a4f0f88041b210ec8674725efab0e2c6c002ff79fd866146330/django-markdown-vinta-0.8.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "27264e93d26cadf34b3cd2fb3ce60355", "sha256": "63d30635c7e61a78f4579ec53aaeab5b884978391dd69e09686edbb726db6603" }, "downloads": -1, "filename": "django-markdown-vinta-0.8.4.tar.gz", "has_sig": false, "md5_digest": "27264e93d26cadf34b3cd2fb3ce60355", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 73885, "upload_time": "2016-08-10T12:00:57", "url": "https://files.pythonhosted.org/packages/a8/82/ac0908b31a4f0f88041b210ec8674725efab0e2c6c002ff79fd866146330/django-markdown-vinta-0.8.4.tar.gz" } ] }