docs/mkdocs.yml at main · letsemploy/docs · 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
105
106
107
108
109
110
111
site_name: "Documentation - Let's Employ"
site_description: "Technical documentation for oJobPub, the open JSON format for publishing job openings at a well-known URL, and the Let's Employ services around it."
site_url: https://docs.letsemploy.org/

repo_url: https://github.com/letsemploy/docs
edit_uri: edit/main/docs/

nav:
  - Home: index.md
  - Publishing:
    - Overview: publishing/index.md
    - Create the Feed: publishing/create.md
    - Serve the Feed: publishing/serve.md
    - Register: publishing/register.md
  - Consuming: consuming/index.md
  - oJobPub:
    - Overview: ojobpub/index.md
    - Specification: ojobpub/specification.md
    - Field Reference: ojobpub/schema.md
  - Services:
    - Overview: resources/index.md
    - SourceTracker: resources/sourcetracker.md
    - Publisher: resources/publisher.md
    - Validator: resources/validator.md
    - Job Search: resources/jobsearch.md
  - FAQ: faq.md
  - letsemploy.org: //letsemploy.org

theme:
  name: material
  features:
    - navigation.tabs
    - content.action.edit
    - content.action.view
  font: false
  logo: static/logo_tp.png
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode


markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - admonition
  - attr_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - def_list
  - footnotes
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - minify:
      minify_html: true
  - redirects:
      redirect_maps:
        'sourcetracker.md': 'resources/sourcetracker.md'
        'ojobpub/format.md': 'ojobpub/specification.md'
        'overview/why.md': 'index.md'
        'overview/approach.md': 'ojobpub/index.md'
        'overview/project.md': 'index.md'
        'overview/faq.md': 'faq.md'
        'quickstart/index.md': 'publishing/index.md'
        'quickstart/requirements.md': 'publishing/index.md'
        'quickstart/create.md': 'publishing/create.md'
        'quickstart/publish.md': 'publishing/serve.md'
        'quickstart/let-us-know.md': 'publishing/register.md'
        'quickstart/spread-the-word.md': 'publishing/register.md'

copyright: |
  LetsEmploy.org © 2025-2026

extra:
  generator: true
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/letsemploy/docs
    - icon: fontawesome/brands/mastodon
      link: https://mstdn.social/@letsemploy_org

extra_css:
  - stylesheets/extra.css