ISO8583-Simulator/mkdocs.yml at main · bassrehab/ISO8583-Simulator · 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
site_name: ISO8583 Simulator
site_description: High-performance ISO 8583 message simulator with CLI, Python SDK, and LLM features
site_author: Subhadip Mitra
site_url: https://iso8583.subhadipmitra.com
repo_url: https://github.com/bassrehab/ISO8583-Simulator
repo_name: ISO8583-Simulator

theme:
  name: material
  palette:
    - scheme: default
      primary: lime
      accent: lime
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: lime
      accent: lime
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - search.highlight
    - search.suggest

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            docstring_style: google
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true

markdown_extensions:
  - pymdownx.highlight:
      use_pygments: true
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - ISO 8583 Concepts: getting-started/concepts.md
  - Architecture:
    - Overview: architecture/overview.md
    - Message Flow: architecture/message-flow.md
    - Module Structure: architecture/module-structure.md
  - Core Module:
    - Overview: core/index.md
    - Types & Fields: core/types.md
    - Parser: core/parser.md
    - Builder: core/builder.md
    - Validator: core/validator.md
    - EMV Data: core/emv.md
    - Object Pool: core/pool.md
  - Card Networks:
    - Overview: networks/index.md
    - VISA: networks/visa.md
    - Mastercard: networks/mastercard.md
    - Other Networks: networks/others.md
  - LLM Features:
    - Overview: llm/index.md
    - Providers: llm/providers.md
    - Message Explainer: llm/explainer.md
    - Message Generator: llm/generator.md
  - CLI Reference: cli/index.md
  - API Reference:
    - Core Module: api/core.md
    - LLM Module: api/llm.md
    - Demo Module: api/demo.md
  - Performance: performance.md
  - Troubleshooting: troubleshooting.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bassrehab/ISO8583-Simulator