@@ -19,25 +19,6 @@ This package aims to make it easy to serve .md files on Django sites.
19
19
.. note ::
20
20
* This package needs tests, and to have Travis and Coveralls properly configured.
21
21
22
- Requirements
23
- ------------
24
-
25
- Tested with:
26
-
27
- **The Tested With section describes aspirational goals. **
28
-
29
- * Python: 3.5, 3.6, 3.7, 3.8
30
- * Django: 2.2, 3.0
31
-
32
-
33
- .. note ::
34
- * Django 2.2 requires SQLite 3.8.3
35
- * Django 2.2 supports Python 3.5, 3.6, and 3.7.
36
- * Django 3.0 supports Python 3.6, 3.7 and 3.8.
37
-
38
- We highly recommend and only officially support the latest release of each series.
39
-
40
-
41
22
Installation
42
23
------------
43
24
@@ -80,9 +61,9 @@ from ``markdown_view.views`` to serve a .md file
80
61
StaffMarkdownView.as_view(file_name = ' my_app/README.md' ),
81
62
name = " readme" ),
82
63
83
-
84
64
Settings
85
65
~~~~~~~~
66
+
86
67
All settings are optional. See `<markdown_view/constants.py >`_ for the defaults.
87
68
88
69
* `MARKDOWN_VIEW_BASE_DIR ` and `BASE_DIR `
@@ -183,13 +164,18 @@ Implementation
183
164
184
165
At a high level, `MarkdownView ` will:
185
166
186
- #. Use a template loader to locate .md given as `file_name `
167
+ #. Use a template loader to locate ` .md ` given as `file_name `
187
168
188
- #. Render as a template, the contents of the .md file prepended with
189
- `{{ % load static %} } `, into several context variables
169
+ #. Render as a template, the contents of the ` .md ` file prepended with
170
+ `{% load static %} `, into several context variables
190
171
191
172
#. Serve the `MARKDOWN_VIEW_TEMPLATE ` with the context variables
192
173
174
+ Release Notes and Contributors
175
+ ------------------------------
176
+
177
+ * `Release notes <https://github.com/rgs258/django-markdown-view/releases >`_
178
+ * `Our wonderful contributors <https://github.com/rgs258/django-markdown-view/graphs/contributors >`_
193
179
194
180
Contributing
195
181
------------
@@ -204,3 +190,15 @@ We use `Travis`_ coupled with `Coveralls`_ as continious integration tools.
204
190
.. _`pull requests` : https://github.com/rgs258/django-markdown-view/pulls
205
191
.. _Travis : https://travis-ci.org/github/rgs258/django-markdown-view
206
192
.. _Coveralls : https://coveralls.io/github/rgs258/django-markdown-view
193
+
194
+ Requirements
195
+ ------------
196
+
197
+ We aspire to support the currently supported versions of Django.
198
+
199
+ **The Tested With section describes aspirational goals. **
200
+
201
+ Tested with:
202
+
203
+ * Python: 3.6, 3.7, 3.8, 3.9, 3.10
204
+ * Django: 2.2, 3.2, 4.0
0 commit comments