devscript/mkdocs.yml at main · xtream1101/devscript · 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
site_name: Devscript Docs
site_url: !ENV DOCS_HOST
repo_url: https://github.com/xtream1101/devscript

nav:
  - index.md
  - Guides:
      - CLI Usage: guides/cli.md
      - Search & Filter: guides/search.md
      - Self-Hosting:
          - Overview: guides/self-hosting/index.md
          - Configuration: guides/self-hosting/configuration.md
  - API:
      - Endpoints: api/endpoints.md
  - Reference:
      - Development: reference/development.md

theme:
  name: material
  custom_dir: docs_overrides
  palette:
    scheme: default
    primary: black
    accent: amber
  logo: assets/logo.svg
  favicon: assets/favicon.ico
  font:
    text: Outfit
  features:
    - navigation.sections
    - navigation.expand
    - navigation.tracking
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.share

plugins:
  - search
  - awesome-pages
  - tags
  - macros
  - swagger-ui-tag
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_root_heading: true
            show_root_full_path: true
            show_root_toc_entry: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_source: false

markdown_extensions:
  - attr_list

extra:
  generator: false
  homepage: !ENV HOST
  app_host: !ENV HOST
  analytics:
    provider: plausible
    plausible_script_url: !ENV PLAUSIBLE_DOCS_SCRIPT_URL
    plausible_site_name: !ENV PLAUSIBLE_DOCS_SITE_NAME