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
site_name: "Documentation - Let's Employ"
site_description: "Let's Employ is a community-driven effort to create an open standard for publishing job listings in a structured format, making it easier for job seekers and employers to connect."
site_url: https://docs.letsemploy.org/

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

nav:
  - Intro: index.md
  - Overview:
    - Why: overview/why.md
    - Our Approach: overview/approach.md
    - FAQ: overview/faq.md
    - Project: overview/project.md

  - Quickstart:
    - Into: quickstart/index.md
    - Requirements: quickstart/requirements.md
    - OJobPub: quickstart/create.md
    - Publish: quickstart/publish.md
    - Let us Know: quickstart/let-us-know.md
    - Spread the Word: quickstart/spread-the-word.md

  - OJobPub:
    - About: ojobpub/index.md
    - Format: ojobpub/format.md
    - Schema: ojobpub/schema.md

  - Software and Services:
    - Overview: resources/index.md
    - SourceTracker: resources/sourcetracker.md
    - Publisher: resources/publisher.md
    # - Jobs Board: resources/jobs-board.md
    - Validator: resources/validator.md
    # - Tools: resources/tools.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: white
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

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


markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - 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'

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://mastodon.social/@letsemploy_org

extra_css:
  - stylesheets/extra.css