canonicalwebteam.django views

canonicalwebteam.django_views

주로 WebTeam Django 앱에서 사용하기위한 Django 앱의보기.

설치

pip install canonicalwebteam.django_views 사용 하여이 모듈을 직접 설치하거나 앱의 requirements.txt 에 canonicalwebteam.django_views 포함시킬 수 있습니다.

템플릿 파인더

TemplateFinder 각 URL에 대한 뷰를 쓸 필요없이 해당 템플릿을 URL에서 직접로드하려고 시도하는 TemplateView 의 확장입니다.

HTML 템플릿을 직접로드하거나 "Wrapper_Template"프론트 매스터 키가 포함 된 마크 다운 파일을 구문 분석 할 수 있습니다.

용법

다음은 Django 앱에서 TemplateFinder 사용하는 방법의 예입니다.

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

템플릿 매칭

앱이 URL을 구문 분석하면 다음 위치에서 템플릿을 찾습니다.

• /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

마크 다운 파싱

TemplateFinder 가 Markdown 파일 (ENDING .md )을 만나면 Yaml FrontMatter에서 다음 키를 찾습니다.

• wrapper_template 필수 : ​​(예 : wrapper_template: /includes/markdown-wrapper.html ) 구문 분석 된 마크 다운 컨텐츠를 배치하는 HTML 템플릿으로가는 경로. 경로에 선행 슬래시가없는 경우 (예 : "Templates/Template.html"또는 "../templates/template.html") TemplateFinder 해당 MarkDown 파일의 위치에 대한 템플릿을 검색합니다. 길이라면
• context 선택 사항 : (예 : context: {title: "Welcome", description: "A welcome page"} ) 추가 키 / 값 쌍 사전으로 템플릿 컨텍스트로 전달됩니다.
• markdown_includes 선택 사항 : (예 : markdown_includes: {nav: } ) 포함 할 마크 다운 파일을 가리키는 템플릿 경로에 키 이름을 매핑합니다. 각 템플릿 경로는 구문 분석되며 결과 HTML은 관련 키에 따라 템플릿 컨텍스트에서 전달됩니다.

다음은 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).