Skip to content

Commit ae7dede

Browse files
committed
Updated README and added installation guide
1 parent 94eda01 commit ae7dede

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

README.rst

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,36 @@ returns a string representing the marked-up text. For example, the
2323
``textile`` filter converts text that is marked-up in Textile format
2424
to HTML.
2525

26+
Installation
27+
------------
28+
``django-markwhat`` is available on pypi:
29+
30+
http://pypi.python.org/pypi/django-markwhat
31+
32+
So easily install it by ``pip``:
33+
::
34+
35+
pip install django-markwhat
36+
37+
Or by ``easy_install``
38+
::
39+
40+
$ easy_install django-markwhat
41+
42+
Another way is by cloning ``django-markwhat``'s `git repo <https://github.com/Alir3z4/django-markwhat>`_ :::
43+
44+
git clone git://github.com/Alir3z4/django-markwhat.git
45+
46+
Then install it by running:
47+
::
48+
49+
$ python setup.py install
50+
51+
Configuration
52+
******************
53+
2654
To activate these filters, add ``'django_markwhat'`` to your
27-
`INSTALLED_APPS` setting. Once you've done that, use
55+
``INSTALLED_APPS`` setting. Once you've done that, use
2856
``{% load markup %}`` in a template, and you'll have access to these filters.
2957

3058
.. warning::
@@ -66,10 +94,12 @@ Markdown
6694
The Python Markdown library supports options named "safe_mode" and
6795
"enable_attributes". Both relate to the security of the output. To enable both
6896
options in tandem, the markdown filter supports the "safe" argument.
69-
70-
{{ markdown_content_var|markdown:"safe" }}
97+
::
98+
99+
{ markdown_content_var|markdown:"safe" }}
71100

72101
.. warning::
73102

74103
Versions of the Python-Markdown library prior to 2.1 do not support the
75104
optional disabling of attributes and by default
105+

0 commit comments

Comments
 (0)