{ "info": { "author": "Geoffrey ROYER", "author_email": "geoffrey.royer@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", "Programming Language :: Python", "Topic :: Software Development :: Code Generators", "Topic :: Text Processing :: Markup" ], "description": "django-markdown-gcir v. 0.1.0\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.. contents::\n\n.. _requirements:\n\nRequirements\n============\n\n- python >= 3.6\n- django >= 2.0\n- markdown\n\n\n.. _installation:\n\nInstallation\n============\n\n**Django markdown** should be installed using pip: ::\n\n pip install django-markdown-gcir\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 re_path('^markdown/', include('django_markdown.urls')),\n\n\nUse django_markdown\n===================\n\n#) Models: ::\n \n from django_markdown.models import MarkdownField\n\n\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\n\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\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\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 += [ re_path(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 original django-markdown happens at github: https://github.com/klen/django_markdown\nDevelopment of django-markdown-gcir happens also at github:\nhttp://github.com/Ge0/django-markdown-gcir\n\n\nContributors\n=============\n\n* klen_ (Kirill Klenov)\n\n* yavorskiy_ (Sergii Iavorskyi)\n\n* Ge0 (Geoffrey ROYER)\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", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Ge0/django-markdown-gcir", "keywords": "html markdown django", "license": "GNU LGPL", "maintainer": "", "maintainer_email": "", "name": "django-markdown-gcir", "package_url": "https://pypi.org/project/django-markdown-gcir/", "platform": "", "project_url": "https://pypi.org/project/django-markdown-gcir/", "project_urls": { "Homepage": "https://github.com/Ge0/django-markdown-gcir" }, "release_url": "https://pypi.org/project/django-markdown-gcir/0.1.0/", "requires_dist": null, "requires_python": "", "summary": "Django markdown support and wysiwyg.\n", "version": "0.1.0" }, "last_serial": 3640830, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "e16dd404cab22ce68a3d11a82568ca69", "sha256": "a368e0213680e38ce29995aadb20aadb266bfcd771f71ecd830af4f50a25f641" }, "downloads": -1, "filename": "django-markdown-gcir-0.1.0.tar.gz", "has_sig": false, "md5_digest": "e16dd404cab22ce68a3d11a82568ca69", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 68934, "upload_time": "2018-03-05T15:19:14", "url": "https://files.pythonhosted.org/packages/21/ce/754dc80e5587082bfa7085d0c642b9dfd459b47722e44b6d2fd66f76bd57/django-markdown-gcir-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e16dd404cab22ce68a3d11a82568ca69", "sha256": "a368e0213680e38ce29995aadb20aadb266bfcd771f71ecd830af4f50a25f641" }, "downloads": -1, "filename": "django-markdown-gcir-0.1.0.tar.gz", "has_sig": false, "md5_digest": "e16dd404cab22ce68a3d11a82568ca69", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 68934, "upload_time": "2018-03-05T15:19:14", "url": "https://files.pythonhosted.org/packages/21/ce/754dc80e5587082bfa7085d0c642b9dfd459b47722e44b6d2fd66f76bd57/django-markdown-gcir-0.1.0.tar.gz" } ] }