PolyAPI/mkdocs.yml at master · LibreCourseUY/PolyAPI · 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
site_name: PolyAPI Documentation
site_description: Polyglot Microservices API Gateway
site_author: PolyAPI Team
site_url: https://librecourseuy.github.io/PolyAPI
repo_url: https://github.com/LibreCourseUY/PolyAPI

docs_dir: ./docs

copyright: Copyright &copy; 2026 PolyAPI

theme:
  name: material
  palette:
    - scheme: slate
      primary: deep purple
      accent: red
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
    - scheme: slate
      primary: deep purple
      accent: red
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
      media: "(prefers-color-scheme: dark)"
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.share

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/LibreCourseUY/PolyAPI

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Architecture Overview: getting-started/architecture.md
  - Gateway:
      - Overview: gateway/overview.md
      - Configuration: gateway/configuration.md
      - API Reference: gateway/api.md
  - Modules:
      - Overview: modules/overview.md
      - Creating a Module: modules/creating.md
      - Sort Module: modules/sort.md
      - My First Module: my-first-module.md
  - Contract:
      - JSON Contract: contract/json-contract.md
      - Error Codes: contract/error-codes.md
      - Contract Overview: CONTRACT.md
  - Development:
      - Contributing: development/contributing.md
      - Testing: development/testing.md
      - Architecture: ARCHITECTURE.md
      - Contributing Guide: CONTRIBUTING.md
  - CLA: CLA.md

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.mark
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true