2024-02-18 19:10:19 +00:00
|
|
|
site_name: RenderCV
|
2024-02-18 18:13:41 +00:00
|
|
|
site_description: LaTeX CV generator engine from a YAML input file.
|
2023-09-13 17:07:22 +00:00
|
|
|
site_author: Sina Atalay
|
|
|
|
|
copyright: Copyright © 2023 Sina Atalay
|
2024-05-05 10:51:42 +00:00
|
|
|
site_url: https://docs.rendercv.com
|
2023-09-10 19:54:36 +00:00
|
|
|
repo_url: https://github.com/sinaatalay/rendercv
|
2023-09-13 17:07:22 +00:00
|
|
|
repo_name: sinaatalay/rendercv
|
2023-09-10 19:54:36 +00:00
|
|
|
edit_uri: edit/main/docs/
|
|
|
|
|
|
2023-09-09 18:43:41 +00:00
|
|
|
theme:
|
|
|
|
|
name: material
|
2024-06-17 18:57:50 +00:00
|
|
|
language: en
|
2024-02-28 20:16:48 +00:00
|
|
|
custom_dir: docs/overrides
|
2023-09-10 19:54:36 +00:00
|
|
|
palette:
|
|
|
|
|
- media: "(prefers-color-scheme: light)"
|
|
|
|
|
scheme: default
|
|
|
|
|
primary: indigo
|
|
|
|
|
accent: indigo
|
|
|
|
|
toggle:
|
|
|
|
|
icon: material/lightbulb-outline
|
|
|
|
|
name: "Switch to dark mode"
|
|
|
|
|
- media: "(prefers-color-scheme: dark)"
|
|
|
|
|
scheme: slate
|
|
|
|
|
primary: indigo
|
|
|
|
|
accent: indigo
|
|
|
|
|
toggle:
|
|
|
|
|
icon: material/lightbulb
|
|
|
|
|
name: "Switch to light mode"
|
2023-09-13 17:07:22 +00:00
|
|
|
|
|
|
|
|
font:
|
|
|
|
|
text: Roboto
|
|
|
|
|
code: Roboto Mono
|
|
|
|
|
|
2023-09-10 19:54:36 +00:00
|
|
|
features:
|
2023-09-13 17:07:22 +00:00
|
|
|
- content.code.copy # the copy-to-clipboard buttons for code blocks
|
|
|
|
|
- content.action.view # view source button for pages
|
|
|
|
|
- navigation.footer # the previous and next buttons in the footer
|
|
|
|
|
- navigation.indexes # allow mother pages to have their own index pages
|
2023-10-20 18:58:43 +00:00
|
|
|
# - navigation.tabs # render classical type of navbar at top
|
|
|
|
|
- navigation.instant # instant navigation for faster page loads
|
|
|
|
|
- navigation.instant.prefetch # prefetch pages for instant navigation
|
|
|
|
|
- navigation.instant.progress # show progress bar for instant navigation
|
2023-09-13 17:07:22 +00:00
|
|
|
- navigation.top # back to top button
|
|
|
|
|
- search.highlight # highlight search results after going to a page
|
|
|
|
|
- search.suggest # show search suggestions while typing
|
2024-05-19 10:10:59 +00:00
|
|
|
- search.share # share search results with others
|
2023-09-13 17:07:22 +00:00
|
|
|
- toc.follow # if toc sidebar doesn't fit, scroll to the active heading
|
2024-05-18 21:02:14 +00:00
|
|
|
- content.code.annotate # allow annotations in code blocks
|
2023-09-09 18:43:41 +00:00
|
|
|
|
|
|
|
|
nav:
|
2023-10-20 18:58:43 +00:00
|
|
|
- Overview: index.md
|
2024-05-18 21:02:14 +00:00
|
|
|
- User Guide:
|
|
|
|
|
- User Guide: user_guide/index.md
|
|
|
|
|
- Structure of the YAML input file: user_guide/structure_of_the_yaml_input_file.md
|
2024-06-17 18:57:50 +00:00
|
|
|
- FAQ: user_guide/faq.md
|
|
|
|
|
- Developer Guide:
|
|
|
|
|
- Developer Guide: developer_guide/index.md
|
|
|
|
|
- Writing Documentation: developer_guide/writing_documentation.md
|
|
|
|
|
- Testing: developer_guide/testing.md
|
|
|
|
|
- FAQ: developer_guide/faq.md
|
2024-02-18 18:13:41 +00:00
|
|
|
- Reference:
|
|
|
|
|
- Reference: reference/index.md
|
|
|
|
|
- cli.py: reference/cli.md
|
|
|
|
|
- data_models.py: reference/data_models.md
|
|
|
|
|
- renderer.py: reference/renderer.md
|
2024-03-17 20:06:50 +00:00
|
|
|
- themes:
|
|
|
|
|
- themes: reference/themes/index.md
|
|
|
|
|
- classic: reference/themes/classic.md
|
2024-04-28 21:16:50 +00:00
|
|
|
- engineeringresumes: reference/themes/engineeringresumes.md
|
2024-04-28 21:48:40 +00:00
|
|
|
- sb2nov: reference/themes/sb2nov.md
|
|
|
|
|
- moderncv: reference/themes/moderncv.md
|
2024-02-19 17:55:03 +00:00
|
|
|
- Changelog: changelog.md
|
2023-09-09 18:43:41 +00:00
|
|
|
|
2023-09-13 18:02:27 +00:00
|
|
|
markdown_extensions:
|
|
|
|
|
# see https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/ for more pymdownx info
|
|
|
|
|
- pymdownx.highlight:
|
|
|
|
|
anchor_linenums: true
|
|
|
|
|
line_spans: __span
|
|
|
|
|
pygments_lang_class: true
|
|
|
|
|
- pymdownx.inlinehilite
|
2024-05-18 21:45:39 +00:00
|
|
|
- pymdownx.extra:
|
|
|
|
|
pymdownx.superfences:
|
|
|
|
|
custom_fences:
|
|
|
|
|
- name: mermaid
|
|
|
|
|
class: mermaid
|
|
|
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
2023-10-20 20:09:19 +00:00
|
|
|
- pymdownx.tabbed: # content tabs
|
|
|
|
|
alternate_style: true
|
2023-09-13 18:02:27 +00:00
|
|
|
- toc:
|
|
|
|
|
permalink: true
|
|
|
|
|
title: Page contents
|
2023-10-20 20:09:19 +00:00
|
|
|
- admonition # blocks like note, warning, tip, etc.
|
2023-09-13 18:02:27 +00:00
|
|
|
|
2023-09-09 18:43:41 +00:00
|
|
|
plugins:
|
|
|
|
|
- search
|
2024-06-17 18:57:50 +00:00
|
|
|
- offline
|
2024-02-23 17:58:53 +00:00
|
|
|
- macros: # mkdocs-macros-plugin
|
2024-03-17 19:30:57 +00:00
|
|
|
module_name: docs/update_rendercv_files
|
2023-09-09 18:59:39 +00:00
|
|
|
- mkdocstrings:
|
|
|
|
|
handlers:
|
|
|
|
|
python:
|
2023-09-10 19:54:36 +00:00
|
|
|
paths:
|
|
|
|
|
- rendercv
|
2023-09-09 18:59:39 +00:00
|
|
|
options:
|
2023-09-10 19:54:36 +00:00
|
|
|
members_order: source
|
2023-09-09 18:59:39 +00:00
|
|
|
show_bases: true
|
2023-09-10 19:54:36 +00:00
|
|
|
docstring_section_style: list
|
2024-02-18 19:10:19 +00:00
|
|
|
merge_init_into_class: true
|
2023-09-10 19:54:36 +00:00
|
|
|
show_docstring_attributes: true
|
2023-09-13 17:07:22 +00:00
|
|
|
docstring_style: google
|
|
|
|
|
|
|
|
|
|
extra_javascript:
|
2024-02-18 19:10:19 +00:00
|
|
|
- assets/javascripts/katex.js
|
2024-02-24 15:20:44 +00:00
|
|
|
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.js
|
|
|
|
|
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/contrib/auto-render.min.js
|
2023-09-13 17:07:22 +00:00
|
|
|
|
|
|
|
|
extra_css:
|
2024-02-24 15:20:44 +00:00
|
|
|
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.css
|
2024-05-19 10:10:59 +00:00
|
|
|
|
|
|
|
|
extra:
|
|
|
|
|
analytics:
|
|
|
|
|
provider: google
|
|
|
|
|
property: G-7D7Y8D5Q4W
|
