reactpy-django/docs/mkdocs.yml at 36bdbc2df1cab83a31759a2d54bf45309a664d96 · Archmonger/reactpy-django · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
---
nav:
    - Home: index.md
    - Get Started:
          - Add ReactPy to a Django Project: learn/add-reactpy-to-a-django-project.md
          - Your First Component: learn/your-first-component.md
    - Reference:
          - Components: reference/components.md
          - Hooks: reference/hooks.md
          - HTML: reference/html.md
          - URL Router: reference/router.md
          - Decorators: reference/decorators.md
          - Utilities: reference/utils.md
          - Template Tag: reference/template-tag.md
          - Settings: reference/settings.md
          - Management Commands: reference/management-commands.md
    - About:
          - Changelog: about/changelog.md
          - Contributor Guide: about/contributing.md
          - Community:
                - GitHub Discussions: https://github.com/reactive-python/reactpy-django/discussions
                - Discord: https://discord.gg/uNb5P4hA9X
                - Reddit: https://www.reddit.com/r/ReactPy/
          - License: about/license.md

theme:
    name: material
    custom_dir: overrides
    palette:
        - media: "(prefers-color-scheme: dark)"
          scheme: slate
          toggle:
              icon: material/white-balance-sunny
              name: Switch to light mode
          primary: red # We use red to indicate that something is unthemed
          accent: red
        - media: "(prefers-color-scheme: light)"
          scheme: default
          toggle:
              icon: material/weather-night
              name: Switch to dark mode
          primary: white
          accent: red
    features:
        - navigation.instant
        - navigation.tabs
        - navigation.tabs.sticky
        - navigation.top
        - content.code.copy
        - search.highlight
    icon:
        repo: fontawesome/brands/github
        admonition:
            note: fontawesome/solid/note-sticky
    logo: https://raw.githubusercontent.com/reactive-python/reactpy/main/branding/svg/reactpy-logo-square.svg
    favicon: https://raw.githubusercontent.com/reactive-python/reactpy/main/branding/svg/reactpy-logo-square.svg

markdown_extensions:
    - toc:
          permalink: true
    - pymdownx.emoji:
          emoji_index: !!python/name:material.extensions.emoji.twemoji
          emoji_generator: !!python/name:material.extensions.emoji.to_svg
    - pymdownx.tabbed:
          alternate_style: true
    - pymdownx.highlight:
          linenums: true
    - pymdownx.superfences
    - pymdownx.details
    - pymdownx.inlinehilite
    - admonition
    - attr_list
    - md_in_html
    - pymdownx.keys

plugins:
    - search
    - include-markdown
    - git-authors
    - minify:
          minify_html: true
          minify_js: true
          minify_css: true
          cache_safe: true
    - git-revision-date-localized:
          fallback_to_build_date: true
    - spellcheck:
          known_words: dictionary.txt
          allow_unicode: no

extra:
    generator: false
    version:
        provider: mike
    analytics:
        provider: google
        property: G-4KFQN2LWBG

extra_javascript:
    - assets/js/main.js

extra_css:
    - assets/css/main.css
    - assets/css/button.css
    - assets/css/admonition.css
    - assets/css/banner.css
    - assets/css/sidebar.css
    - assets/css/navbar.css
    - assets/css/table-of-contents.css
    - assets/css/code.css
    - assets/css/footer.css
    - assets/css/home.css

watch:
    - ../docs
    - ../README.md
    - ../CHANGELOG.md
    - ../LICENSE.md
    - ../.mailmap

site_name: ReactPy-Django
site_author: Archmonger
site_description: It's React, but in Python. Now with Django integration.
copyright: '&copy; <div id="year"></div> <script>document.getElementById("year").innerHTML = new Date().getFullYear();</script> Reactive Python and affiliates. <div class="legal-footer-right">This project has no affiliation to ReactJS or Meta Platforms, Inc.</div>'
repo_url: https://github.com/reactive-python/reactpy-django
site_url: https://reactive-python.github.io/reactpy-django
repo_name: ReactPy Django
edit_uri: edit/main/docs/src
docs_dir: src