awesome-resumes/mkdocs.yml at main · ManiMozaffar/awesome-resumes · 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
112
113
114
115
116
117
118
119
120
121
site_name: Awesome Resumes
site_description: Create resumes and CV with awesome-resumes. Practical tips, guidelines, guide, examples and documentation for all IT fields
repo_url: https://github.com/ManiMozaffar/awesome-resumes
site_url: https://ManiMozaffar.github.io/awesome-resumes
site_author: Mani Mozaffar
repo_name: ManiMozaffar/awesome-resumes
copyright: Maintained by <a href="https://ManiMozaffar.com">Mani Mozaffar</a>.

theme:
  name: "material"
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference

  features:
    - navigation.tabs
    - navigation.instant
    - content.code.annotate
    - content.tabs.link
    - content.code.copy
    - announce.dismiss
    - search.suggest
    - search.highlight
  # logo: assets/logo-white.svg
  # favicon: assets/favicon.png

edit_uri: ""

# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

extra:
  navigation:
    next: true
    previous: true

extra_css:
  - "extra/tweaks.css"

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.extra
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - attr_list
  - md_in_html

plugins:
  - search:
  - mkdocstrings:
      handlers:
        python:
          options:
            members_order: source
            separate_signature: true
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_signature_annotations: true
            signature_crossrefs: true

  - mkdocs-simple-hooks:
      hooks:
        on_pre_build: "docs.plugins:on_pre_build"
        on_files: "docs.plugins:on_files"
        on_page_markdown: "docs.plugins:on_page_markdown"

nav:
  - Documentation:
      - Getting Started: index.md
      - Definitions: definitions.md
      - Resume Structure: guidelines/structure.md
      - Common Mistakes: guidelines/common_mistakes.md
      - Application Tracking System(ATS): guidelines/ats.md
      - Shotgun vs target approach: guidelines/shotgun_vs_target.md

      - Mandatory Resume Sections:
          - Personal Information: sections/personal_information.md
          - Summary: sections/summary.md
          - Skills: sections/skills.md
          - Work Experience: sections/work_experience.md
      - Optional Resume Sections:
          - Education: sections/education.md
          - Projects: sections/projects.md
          - References: sections/references.md
          - Certifications & Trainings: sections/certifications.md
          - Publications & Conferences: sections/publications.md
          - Volunteer Experience: sections/volunteer_experience.md
          - Awards: sections/awards.md
          - Memberships: sections/memberships.md
          - Languages: sections/languages.md

      - Templates: guidelines/templates.md
      - After Sending Resume: guidelines/after_sending_resume.md

  - Samples: samples.md