Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Commit

Permalink
sync index.rst with README
Browse files Browse the repository at this point in the history
  • Loading branch information
sv0 committed Apr 2, 2017
1 parent 8b736bc commit a7e7619
Showing 1 changed file with 46 additions and 10 deletions.
56 changes: 46 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,42 @@
Django-Markdown v. 0.9.0
Django-Markdown v. 0.9.1
########################

.. _description:

**Django markdown** is django application that allows use markdown wysiwyg in flatpages, admin forms and other forms.
**Django markdown** is django application that allows use markdown_ wysiwyg in flatpages, admin forms and other forms.
Documentaton available at pypi_ or github_.

It's a fork of https://github.com/klen/django_markdown

The reason of forking is the original project is not maintained anymore and the owner(klen_) is not interested in the merging of the pull requests.


.. _badges:

.. image:: https://travis-ci.org/sv0/django-markdown-app.svg?branch=master
:target: https://travis-ci.org/sv0/django-markdown-app
:alt: Build Status

.. image:: https://coveralls.io/repos/github/sv0/django-markdown-app/badge.svg?branch=master
:target: https://coveralls.io/github/sv0/django-markdown-app?branch=master
:alt: Coverals

.. image:: http://img.shields.io/pypi/v/django-markdown-app.svg?style=flat-square
:target: https://pypi.python.org/pypi/django-markdown-app
:alt: Version

.. image:: http://img.shields.io/pypi/dm/django-markdown-app.svg?style=flat-square
:target: https://pypi.python.org/pypi/django-markdown-app
:alt: Downloads

.. image:: http://img.shields.io/pypi/l/django-markdown-app.svg?style=flat-square
:target: https://pypi.python.org/pypi/django-markdown-app
:alt: License

.. image:: http://img.shields.io/gratipay/klen.svg?style=flat-square
:target: https://www.gratipay.com/klen/
:alt: Donate

.. contents::

.. _requirements:
Expand All @@ -20,8 +46,10 @@ Requirements

- python >= 2.7
- django >= 1.8
- markdown
- markdown >= 2.6.7


.. _installation:

Installation
============
Expand All @@ -31,12 +59,18 @@ Installation
pip install django-markdown-app


Prerequisites
=============

Starting with version 0.9.0, django-markdown-app requires Django 1.8 or later.
If you need to support Django versions prior to 1.8 please use django-markdown-app 0.8.5.


Setup
=====

.. note:: 'django_markdown' require 'django.contrib.staticfiles' in INSTALLED_APPS


- Add 'django_markdown' to INSTALLED_APPS ::

INSTALLED_APPS += ( 'django_markdown', )
Expand All @@ -51,10 +85,10 @@ Use django_markdown
===================

#) Models: ::

from django_markdown.models import MarkdownField
from django_markdown.models import MarkdownField


class MyModel(models.Model):
content = MarkdownField()

Expand All @@ -73,14 +107,14 @@ Use django_markdown
#) Custom admins: ::

from django_markdown.admin import MarkdownModelAdmin

admin.site.register(MyModel, MarkdownModelAdmin)


#) Admin Overrides: (If you don't want to subclass package ModelAdmin's) ::

from django.contrib import admin

class YourModelAdmin(admin.ModelAdmin):
formfield_overrides = {MarkdownField: {'widget': AdminMarkdownWidget}}

Expand All @@ -95,6 +129,7 @@ Use django_markdown
flatpages.register()
urlpatterns += [ url(r'^admin/', include(admin.site.urls)), ]


#) Template tags: ::

<textarea name="test" id="new"></textarea>
Expand Down Expand Up @@ -135,7 +170,7 @@ Example: `settings.py` ::
Examples
========

Execute `make run` in sources directory. Open http://127.0.0.1:8000 in your
Execute *make run* in sources directory. Open http://127.0.0.1:8000 in your
browser. For admin access use 'root:root' credentials.


Expand All @@ -158,7 +193,7 @@ at https://github.com/sv0/django-markdown-app/issues
Contributing
============

Development of django-markdown-app happens at github: https://github.com/sv0/django-markdown-app
Development of django-markdown happens at github: https://github.com/sv0/django-markdown-app


Contributors
Expand Down Expand Up @@ -191,3 +226,4 @@ Markitup_:
.. _github: https://github.com/sv0/django-markdown-app
.. _klen: https://github.com/klen
.. _yavorskiy: https://github.com/yavorskiy
.. _markdown: https://pythonhosted.org/Markdown/

0 comments on commit a7e7619

Please sign in to comment.