django-erd/mkdocs.yml at main · marzukia/django-erd · 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
site_name: Django ERD Generator
site_description: Generate Entity-Relationship Diagrams from Django models
site_url: https://django-erd.mrzk.io
repo_url: https://github.com/marzukia/django-erd
repo_name: marzukia/django-erd

# Social metadata
copyright: Copyright © 2024 Marzukia

theme:
  name: material
  logo: img/logo.svg
  favicon: img/logo.svg
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.integrate
    - toc.follow
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.action.edit

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
      toc_depth: 3

nav:
  - Home: index.md
  - Installation: installation.md
  - Quickstart: quickstart.md
  - Features:
      - ERD Generation: features/erd-generation.md
      - Data Dictionary: features/data-dictionary.md
      - Supported Dialects: features/supported-dialects.md
      - GIS Fields: features/gis-fields.md
  - API Reference: api.md
  - Contributing: contributing.md
  - Changelog: changelog.md

plugins:
  - search
  - social:
      cards_layout_options:
        background_color: #4f46e5
        color: white

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/marzukia/django-erd
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/django-erd/
  analytics:
    provider: google
    property: G-XXXXXXXXXX