supernotify/mkdocs.yml at main · rhizomatics/supernotify · 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
130
131
132
133
134
135
136
137
138
139
site_name: Home Assistant Supernotify
site_url: 'https://supernotify.rhizomatics.org.uk'
site_description: Advanced, concise, flexible notifications for Home Assistant

repo_name: rhizomatics/supernotify
repo_url: https://github.com/rhizomatics/supernotify
edit_uri: edit/main/docs/

theme:
  name: material
  highlightjs: true
  language: en
  logo: assets/images/logo-blank-256x256.png
  icon:
    repo: fontawesome/brands/github
  features:
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search
    - search.share
    - toc.follow
    - toc.integrate

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rhizomatics

plugins:
  - search
  - htmlproofer:
      skip_downloads: True
      validate_external_urls: False
      ignore_pages:
        - developer/schemas/*
        - developer/classes.md
      ignore_urls:
        - ../../developer/schemas/*

  - autorefs
  - pagetree
  - optimize
  - tags
  - meta-descriptions
  - social:
      cards_layout_options:
        logo: docs/assets/images/icon.png
        background_image: docs/assets/images/logo-dim-social-640x320.png
        background_color: transparent
  - mike:
      alias_type: symlink
      canonical_version: latest
      version_selector: true
  - minify:
      minify_html: true
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - coverage:
      page_path: developer/coverage
      html_report_dir: htmlcov
  - mkdocstrings:
      handlers:
      # See: https://mkdocstrings.github.io/python/usage/
        python:
          options:
            show_source: false
            show_root_heading: true
            summary: true
            show_inheritance_diagram: true
            docstring_section_style: spacy
  - gen-files:
      scripts:
        - docgen/schema_extractor.py
        - docgen/transport_table.py
        - docgen/render_templates.py


watch:
  - custom_components/supernotify

markdown_extensions:
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - toc:
      permalink: true
  - sane_lists
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

not_in_nav: |
  de/
  es/
  fr/
  hi/
  it/
  ja/
  nl/
  pl/
  pt/
  zh-Hans/

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn