https://github.com/marcanuy/django-mdpages

Django CBV subclass to generate pages from Markdown files.
https://github.com/marcanuy/django-mdpages

django markdown static-pages

Last synced: about 1 month ago
JSON representation

Django CBV subclass to generate pages from Markdown files.

• Host: GitHub
• URL: https://github.com/marcanuy/django-mdpages
• Owner: marcanuy
• License: mit
• Created: 2019-03-08T19:37:31.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-18T21:00:34.000Z (almost 6 years ago)
• Last Synced: 2024-12-07T19:50:36.217Z (about 2 months ago)
• Topics: django, markdown, static-pages
• Language: Python
• Homepage:
• Size: 28.3 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
MdPages - Markdown Pages

========================

Mdpages is a simple Django app to generate pages from Markdown

files.

Pages also can have a Table of Content automatically generated based

on headings. Basically static pages from Markdown files.

Why?

----

This CBV is userful in these circunstances:

- To generate pages part of the website like the typical About page

- You want those pages

  - in plain Markdown

  - to be naturally part of the website layout (e.g.: extends `base.html`).

  - to be in version control along website code.

Install

-------

To install:

.. code:: bash

   pip install django-mdpages

Quick start

-----------

Supposing you want to create an **About** page, having the markdown

file at `/pages/content/about.md`.

1. Add "mdpages" to your INSTALLED_APPS setting like this:

.. code:: python

   INSTALLED_APPS = [

	   ...

	   'mdpages',

   ]

2. Set the location of the directory that will contain the Markdown

   files in settings with `MDPAGES_CONTENT_DIR`:

.. code:: python

   MDPAGES_CONTENT_DIR = '{}/pages/content/'.format(BASE_DIR)

3. Add the template that will contain the Markdown generated content,

   you will have two variables available: `body` and `toc` (for the

   table of contents), for example create a template

   `/templates/mdpages/page.html` with contents like:

.. code:: python

   {% extends "base.html" %}

   {% block title %}{{title}}{%endblock%}

   {% block description %}{{description}}{%endblock%}

   {% block content %}

   


        {{ toc|safe }}

	


	{{ body|safe }}

   

   {% endblock %}


And add the template path to settings `MDPAGES_TEMPLATE_NAME`:

.. code:: python

	

   MDPAGES_TEMPLATE_NAME = 'mdpages/page.html'

4. Create a view using `mdpages.views.MdPageView` specifying

   the name of the Markdown file `md_file` and the `template_name`:

.. code:: python

   from mdpages.views import MdPageView

   class AboutView(MdPageView):

	   md_file = 'language-learning.md'

	   # any kind of extra content used in your template

	   extra_context = {

		   'title': 'About page',

		   'description': 'This is the about page of the site.'

	   }

5. Use it in your `urls.py`:

.. code:: python

   from .views import AboutView

   urlpatterns = [

	   path('about', AboutView.as_view()),	

   ]

Example

-------

There is an example project using it at

[exampleSite](https://github.com/marcanuy/django-mdpages/tree/master/exampleSite)

that just displays an *About* page from [about.md](https://github.com/marcanuy/django-mdpages/blob/master/exampleSite/pages/content/about.md).

Reference

---------

- Markdown library https://python-markdown.github.io/reference/

- PyPi https://pypi.org/project/django-mdpages/