canonicalwebteam.django views

CanonicalWebTeam.django_views

Tampilan untuk aplikasi Django, terutama untuk digunakan di aplikasi Webteam Django.

Instalasi

Anda dapat menginstal modul ini secara langsung dengan pip install canonicalwebteam.django_views , atau sebagai alternatif, sertakan canonicalwebteam.django_views di requirements.txt untuk aplikasi Anda.

TemplateFinder

TemplateFinder adalah perpanjangan dari TemplateView yang berupaya memuat templat yang sesuai langsung dari URL, tanpa perlu menulis tampilan untuk setiap URL.

Ini dapat memuat templat HTML secara langsung, atau parse file markdown yang berisi kunci frontMatter "wrapper_template".

Penggunaan

Berikut adalah contoh cara memanfaatkan TemplateFinder di aplikasi Django Anda:

 # urls.py
from django . conf . urls import url
from canonicalwebteam . django_views import TemplateFinder
# ...
urlpatterns += url ( r"$^" , TemplateFinder . as_view ()),

Pencocokan template

Ketika aplikasi mem -parsing URL, ia akan mencari template di lokasi berikut, secara berurutan:

• /parent/location/ => templates/parent/location.html
• /parent/location/ => templates/parent/location/index.html
• /parent/location/ => templates/parent/location.md
• /parent/location/ => templates/parent/location/index.md

Parsing Markdown

Jika TemplateFinder menemukan file penurunan harga (akhir .md ) itu akan mencari kunci berikut di frontmatter YAML:

• wrapper_template wajib : (misalnya: wrapper_template: /includes/markdown-wrapper.html ) jalur ke templat HTML untuk menempatkan konten penurunan harga yang diuraikan. Jika jalur tidak memiliki slash terkemuka (misalnya templat/template.html "atau" ../templates/template.html "), maka TemplateFinder akan mencari templat relatif terhadap lokasi file markdown yang dimaksud. Jika jalannya
• context Opsional : (Misalnya: context: {title: "Welcome", description: "A welcome page"} ) Kamus pasangan kunci / nilai tambahan untuk dilewati ke konteks template.
• markdown_includes Opsional : (misalnya: markdown_includes: {nav: } ) Pemetaan nama kunci ke jalur templat yang menunjuk ke file markdown untuk disertakan. Setiap jalur templat akan diuraikan, HTML yang dihasilkan akan dilewati dalam konteks template, di bawah kunci yang relevan.

Berikut contoh file markdown:

    ---
    wrapper_template: "/includes/markdown-wrapper.html"
    markdown_includes:
      nav: "includes/nav.md"
    context:
      title: "Welcome"
      description: "A welcome page"
    ---
    
    Welcome to my website.
    
    ## GitHub
    
    I also have [a GitHub page](https://github.com/me).