django-planet/mkdocs.yml at main · matagus/django-planet · 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
site_name: django-planet
site_url: https://django-planet.readthedocs.io/
site_description: "A reusable Django app for building RSS/Atom feed aggregator websites."
repo_url: https://github.com/matagus/django-planet
repo_name: matagus/django-planet

theme:
  name: material
  palette:
    - scheme: default
      primary: green
      accent: light green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: green
      accent: light green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.path
    - navigation.expand
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - toc.follow
    - content.code.copy
    - search.suggest
    - search.highlight
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Getting Started:
    - Installation: installation.md
    - Usage: usage.md
  - Reference:
    - Configuration: configuration.md
    - Models & Managers: models.md
    - Templates & Tags: templates.md
    - Admin Interface: admin.md
  - About:
    - Demo & Screenshots: demo.md
    - Contributing: contributing.md

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - def_list
  - tables
  - md_in_html

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/matagus/django-planet
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/django-planet/