Hopiu/django-markdownx
1
0
Fork 0
mirror of https://github.com/Hopiu/django-markdownx.git synced 2026-05-23 19:55:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

README update

Browse source
This commit is contained in:
Adrian 2014-11-01 23:16:52 +01:00
parent 5e7aace837
commit 951c946386
1 changed files with 38 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
README.md
View file

@ -6,56 +6,56 @@ It is simply an extension of the Django's Textarea widget made for editing Markd
## Quick Start
### 1. Install *django-markdownx* package:
1. Install *django-markdownx* package
```python
pip install django-markdownx
```
```python
pip install django-markdownx
```
### 2. Add *markdownx* to your *INSTALLED_APPS*:
1. Add *markdownx* to your *INSTALLED_APPS*
```python
INSTALLED_APPS = (
[...]
'markdownx',
```
```python
INSTALLED_APPS = (
[...]
'markdownx',
```
### 3. Add *url* pattern to your *urls.py*
1. Add *url* pattern to your *urls.py*
```python
urlpatterns = [
[...]
url(r'^markdownx/', include('markdownx.urls')),
]
```
```python
urlpatterns = [
[...]
url(r'^markdownx/', include('markdownx.urls')),
]
```
### 4. Use *MarkdownxInput* widget in your *forms.py*
1. Use *MarkdownxInput* widget in your *forms.py*
```python
from django import forms
from markdownx.widgets import MarkdownxInput
class MyForm(forms.ModelForm):
content = forms.CharField(widget=MarkdownxInput)
```
```python
from django import forms
from markdownx.widgets import MarkdownxInput
class MyForm(forms.ModelForm):
content = forms.CharField(widget=MarkdownxInput)
```
### 5. Use *manage.py collectstatic*
1. Use *manage.py collectstatic*
Use `manage.py collectstatic` to copy files:
Use `manage.py collectstatic` to copy files:
static/css/markdownx.css
static/js/markdown.js
static/css/markdownx.css
static/js/markdown.js
1. Include *[jquery](http://jquery.com)* and *[marked.js](https://github.com/chjj/marked)* file
### 6. Include *[jquery](http://jquery.com)* and *[marked.js](https://github.com/chjj/marked)* file
```html
<head>
[...]
<script src="{{ STATIC_URL }}js/jquery.js"></script>
<script src="{{ STATIC_URL }}js/marked.js"></script>
</head>
```
```html
<head>
[...]
<script src="{{ STATIC_URL }}js/jquery.js"></script>
<script src="{{ STATIC_URL }}js/marked.js"></script>
</head>
```
# Settings