JobHub/mkdocs.yml at main · DavidRodriguez-create/JobHub · 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: JobHub
site_description: Multi-service job-tracking platform — architecture, development & API reference.
site_url: https://davidrodriguez-create.github.io/JobHub/
repo_url: https://github.com/DavidRodriguez-create/JobHub
repo_name: DavidRodriguez-create/JobHub
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - navigation.indexes
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight
    - toc.follow
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - swagger-ui-tag

hooks:
  - docs/hooks/copy_openapi.py

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Architecture:
      - Overview: architecture/overview.md
      - Hexagonal (Ports & Adapters): architecture/hexagonal.md
      - Clean (Concentric layers): architecture/clean.md
  - Development:
      - Local setup: development/local-setup.md
      - Conventions: development/conventions.md
      - Testing: development/testing.md
      - Adding a feature: development/adding-a-feature.md
  - Services:
      - crawler-service: services/crawler.md
      - job-service: services/job.md
      - auth-service: services/auth.md
      - application-service: services/application.md
  - API reference:
      - auth-service: api/auth.md
      - job-service: api/job.md
      - application-service: api/application.md
  - Deployment: deployment.md