RECODE/zensical.toml at main · BAMresearch/RECODE · 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
[project]
site_name = "RECODE"
site_description = "Crash Course on REsearch COding and DEvelopment (RECODE)."
site_author = "BAM RECODE Team"
copyright = """
MIT &copy; 2026 The BAM RECODE Team.
"""
nav = [
  { "Get started" = "index.md" },
  { "Module 1 - Foundations of Python coding" = [
    "module1-foundations_of_python_coding/index.md",
    "module1-foundations_of_python_coding/study-guide.md",
    "module1-foundations_of_python_coding/getting-ready.md",
    "module1-foundations_of_python_coding/python-basics.md",
    "module1-foundations_of_python_coding/control-flow-and-data-structures.md",
    "module1-foundations_of_python_coding/working-with-files-and-data.md",
    "module1-foundations_of_python_coding/code-quality-and-good-practices.md",
    "module1-foundations_of_python_coding/object-oriented-programming.md",
    "module1-foundations_of_python_coding/project-organization.md",
  ]},
  { "Module 2 - Git and GitHub for Version Control" = [
    "module2-git_and_github_for_version_control/index.md",
  ]},
  { "Module 3 - Using Large Language Models (LLMs) for Coding Assistance" = [
    "module3-using_large_language_models_for_coding_assistance/index.md",
  ]},
  { "Module 4 - Packaging and Distributing Python Projects" = [
    "module4-packaging_and_distributing_python_projects/index.md",
  ]},
]

[project.theme]
favicon = "images/recode_logo.png"
language = "en"
features = [
    "announce.dismiss",
    "content.code.annotate",
    "content.code.copy",
    "content.code.select",
    "content.footnote.tooltips",
    "content.tabs.link",
    "content.tooltips",
    "navigation.footer",
    "navigation.indexes",
    "navigation.instant",
    "navigation.instant.prefetch",
    "navigation.path",
    "navigation.sections",
    "navigation.top",
    "navigation.tracking",
    "search.highlight",
]
logo = "images/recode_logo.png"

# Palette toggle for light mode
[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

# Palette toggle for dark mode
[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/BAMresearch/RECODE"

# ----------------------------------------------------------------------------
# In this section you can configure the Markdown extensions that are used when
# rendering your documentation. We enable the most useful extensions by default,
# but you can customize this list to your needs.
#
# Read more:
# - https://zensical.org/docs/setup/extensions/
# ----------------------------------------------------------------------------
[project.markdown_extensions.abbr]
[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.def_list]
[project.markdown_extensions.footnotes]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.toc]
permalink = true
[project.markdown_extensions.pymdownx.arithmatex]
generic = true
[project.markdown_extensions.pymdownx.betterem]
[project.markdown_extensions.pymdownx.caret]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.emoji]
emoji_generator = "zensical.extensions.emoji.to_svg"
emoji_index = "zensical.extensions.emoji.twemoji"
[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.keys]
[project.markdown_extensions.pymdownx.magiclink]
[project.markdown_extensions.pymdownx.mark]
[project.markdown_extensions.pymdownx.smartsymbols]
[project.markdown_extensions.pymdownx.superfences]
custom_fences = [
  { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" }
]
[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
combine_header_slug = true
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true
[project.markdown_extensions.pymdownx.tilde]