iso20022-ecore/mkdocs.yml at main · chris-day/iso20022-ecore · 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
# ============================================================================
# MkDocs configuration
# ============================================================================
# Location: repository root (NOT under docs/)
# Purpose : Build Wiki-compatible documentation with search + network graph
# ============================================================================

site_name: ISO20022 Ecore
site_description: ISO20022 Ecore Helper
site_author: Chris Day
site_url: https://chris-day.github.io/iso20022-ecore/


# ----------------------------------------------------------------------------
# Content location
# ----------------------------------------------------------------------------
docs_dir: docs

# CRITICAL: preserves GitHub Wiki-style URLs and inbound links
use_directory_urls: false

# ----------------------------------------------------------------------------
# Theme
# ----------------------------------------------------------------------------
theme:
  name: material
# features:
#   - navigation.tabs
#   - navigation.sections
#   - navigation.indexes
#   - search.highlight
#   - search.suggest
#   - content.code.copy

# ----------------------------------------------------------------------------
# Markdown extensions
# ----------------------------------------------------------------------------
markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
# ----------------------------------------------------------------------------
# Plugins
# Order matters
# ----------------------------------------------------------------------------
plugins:
  # 1. Search index
  - search:
      lang: en

  # 2. Documentation topology graph
  - graph:
      name: title      # use page titles as node labels
      debug: false
# ----------------------------------------------------------------------------
# Optional CSS (safe to include even if file doesn’t exist yet)
# ----------------------------------------------------------------------------
extra_css:
  - stylesheets/extra.css

# ----------------------------------------------------------------------------
# Navigation
# NOTE:
# - Keep filenames exactly as they exist in the former Wiki
# - Do NOT rename pages casually
# ----------------------------------------------------------------------------
nav:
  - Home: index.md

  - Getting Started:
      - Quick Start: Quick-Start.md

  - emf-read:
      - emf-read CLI: emf-read.md
      - Filter Language: Filter-Language.md
      - Query Language Deep Dive: Query-Language-Deep-Dive.md
      - Exports & Formats: Exports-and-Formats.md
      - JSON Schemas: JSON-Schemas.md
      - API Usage: API-Usage.md
      - Graph Exports: Graph-Exports.md
      - Path Exports: Path-Exports.md
      - Pruning & Dry-Run: Pruning-and-Dry-Run.md
      - Instance Grouping: Instance-Grouping.md

  - xsd-enrich:
      - xsd-enrich CLI: xsd-enrich.md
      - XSD Mapping Rules: XSD-Mapping-Rules.md

  - Internals:
      - Architecture: Architecture.md
      - Troubleshooting: Troubleshooting.md
      - FAQ: FAQ.md