umlwriter/mkdocs.yml at master · llaville/umlwriter · 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: UMLWriter
site_url: https://llaville.github.io/umlwriter/4.4
repo_url: https://github.com/llaville/umlwriter # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository
site_author: Laurent Laville
edit_uri: "" # hide edit button -- https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#edit-button
theme:
    name: material
    palette: # Color palette toggle -- https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-palette-toggle
        # editorconfig-checker-disable
        - scheme: default
          primary: red
          toggle:
              icon: material/lightbulb-outline
              name: Switch to dark mode
        - scheme: slate
          toggle:
              icon: material/lightbulb
              name: Switch to light mode
        # editorconfig-checker-enable
    features:
        - navigation.instant # Instant loading -- https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading
        - navigation.tabs # Navigation tabs -- https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs
        - navigation.indexes # Section index pages -- https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
        - navigation.top # Back-To-Top button -- https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button
        - navigation.footer # Setting up the footer -- https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/
        - content.code.copy # Code copy button -- https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-copy-button
        - content.code.annotate # Code blocks, Adding annotations -- https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-annotations
markdown_extensions:
    - attr_list
    - md_in_html # https://squidfunk.github.io/mkdocs-material/reference/grids/
    - tables # https://squidfunk.github.io/mkdocs-material/reference/data-tables/
    - footnotes # https://squidfunk.github.io/mkdocs-material/reference/footnotes/
    - pymdownx.highlight: # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight
          anchor_linenums: true
          line_spans: __span
          pygments_lang_class: true
    - pymdownx.snippets
    - pymdownx.tabbed: # https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#content-tabs
          alternate_style: true
    - pymdownx.superfences: # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences
          custom_fences:
              - name: mermaid
                class: mermaid
                format: !!python/name:pymdownx.superfences.fence_code_format
    - pymdownx.emoji: # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#emoji
          emoji_index: !!python/name:material.extensions.emoji.twemoji
          emoji_generator: !!python/name:material.extensions.emoji.to_svg
    - github-callouts
nav:
    - "Home": README.md
    - "Installation": installation.md
    - "Getting-Started": usage/README.md
    - "Architecture": architecture/README.md
    - "Features":
          - "Configuration": 01_Features/Configuration.md
          - "Services": 01_Features/Services.md
    - "Commands":
          - "Class diagrams": 02_Console_Commands/diagram_class.md
    - "Cookbook":
          - "Application diagram": 03_Cookbook/01_UmlWriter_public_architecture.md
          - "Application diagram with public methods only": 03_Cookbook/02_UmlWriter_public_methods_only.md
          - "Use a custom class autoloader": 03_Cookbook/03_Custom_autoloader.md
    - "Contributors":
          - "Generators": 90_For_Developers/1_Generators.md
          - "Creating a new generator": 90_For_Developers/2_Creating_a_Generator.md