documentation/zensical.toml at main · omegaup/documentation · 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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
[project]
site_name = "omegaUp Documentation"
# Update this URL after creating your GitHub repository
# Format: https://YOUR_USERNAME.github.io/YOUR_REPO_NAME
# Or use your custom domain: https://docs.omegaup.com
site_url = "https://antedotee.github.io/omegaup-docs/"
site_dir = "site/en"
copyright = "Copyright &copy; 2025 omegaUp"
docs_dir = "docs/en"
use_directory_urls = true
extra_css = ["stylesheets/omegaup-theme.css"]
extra_javascript = ["javascripts/docs-layout-fix.js"]

[project.theme]
name = "material"
palette.primary = "custom"
palette.accent = "custom"
palette.scheme = "default"
language = "en"
# Same asset as frontend/www/favicon-76x76.png (Ω mark, 76×76 PNG)
favicon = "assets/images/favicon-76x76.png"
# PNG wordmark matches main app branding; SVG variant looks different in the header
logo = "assets/images/omegaup.png"
custom_dir = "overrides"
features = [
    "navigation.tabs",
    "navigation.sections",
    "navigation.expand",
    "navigation.indexes",
    "navigation.top",
    "search.suggest",
    "search.highlight",
    "content.code.copy",
    "content.code.annotate",
]

[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.tables]
[project.markdown_extensions.pymdownx.arithmatex]
[project.markdown_extensions.pymdownx.betterem]
[project.markdown_extensions.pymdownx.caret]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"
emoji_generator = "zensical.extensions.emoji.to_svg"
options.custom_icons = ["overrides/.icons"]
[project.markdown_extensions.pymdownx.highlight]
[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]
# Enable Mermaid diagram rendering (Zensical-native integration)
custom_fences = [
    { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
]
[project.markdown_extensions.pymdownx.tasklist]
[project.markdown_extensions.pymdownx.tilde]

#
# Navigation
[[project.nav]]
"Getting Started" = [
    { "Overview" = "getting-started/" },
    { "Development Setup" = "getting-started/development-setup.md" },
    { "Contributing" = "getting-started/contributing.md" },
    { "Getting Help" = "getting-started/getting-help.md" },
]

[[project.nav]]
"Architecture" = [
    { "Overview" = "architecture/" },
    { "Internals" = "architecture/internals.md" },
    { "Backend" = "architecture/backend.md" },
    { "Frontend" = "architecture/frontend.md" },
    { "Database Schema" = "architecture/database-schema.md" },
    { "MVC Pattern" = "architecture/mvc-pattern.md" },
    { "Grader Internals" = "architecture/grader-internals.md" },
    { "Runner Internals" = "architecture/runner-internals.md" },
    { "Gitserver" = "architecture/gitserver.md" },
    { "Broadcaster" = "architecture/broadcaster.md" },
    { "Infrastructure" = "architecture/infrastructure.md" },
    { "Security" = "architecture/security.md" },
]

[[project.nav]]
"Features" = [
    { "Overview" = "features/" },
    { "Arena" = "features/arena.md" },
    { "Grader" = "features/grader.md" },
    { "Runner" = "features/runner.md" },
    { "Sandbox" = "features/sandbox.md" },
    { "Problem Versioning" = "features/problem-versioning.md" },
    { "Realtime Updates" = "features/realtime.md" },
    { "Verdicts" = "features/verdicts.md" },
    { "Badges" = "features/badges.md" },
    { "Contests" = [
        { "Overview" = "features/contests/" },
        { "Managing contests" = "features/contests/managing-contests.md" },
    ]},
    { "Problems" = [
        { "Overview" = "features/problems/" },
        { "Problem format" = "features/problems/problem-format.md" },
        { "Creating problems" = "features/problems/creating-problems.md" },
    ]},
]

[[project.nav]]
"Development" = [
    { "Overview" = "development/" },
    { "Coding Guidelines" = "development/coding-guidelines.md" },
    { "Testing" = "development/testing.md" },
    { "Components" = "development/components.md" },
    { "Database Patterns" = "development/database-patterns.md" },
    { "Migration Guide" = "development/migration-guide.md" },
    { "Useful Commands" = "development/useful-commands.md" },
    { "GSoC page generation" = "development/gsoc-data-generation.md" },
]

[[project.nav]]
"API Reference" = [
    { "Overview" = "api/" },
    { "REST API" = "api/rest-api.md" },
    { "Authentication" = "api/authentication.md" },
    { "Users" = "api/users.md" },
    { "Problems" = "api/problems.md" },
    { "Contests" = "api/contests.md" },
    { "Runs" = "api/runs.md" },
    { "Clarifications" = "api/clarifications.md" },
    { "Groups" = "api/groups.md" },
    { "Teams" = "api/teams.md" },
    { "Schools" = "api/schools.md" },
    { "Badges" = "api/badges.md" },
    { "Certificates" = "api/certificates.md" },
    { "Tags" = "api/tags.md" },
    { "Quality Nominations" = "api/quality-nominations.md" },
    { "Admin" = "api/admin.md" },
    { "Error Codes" = "api/error-codes.md" },
]

[[project.nav]]
"Operations" = [
    { "Overview" = "operations/" },
    { "Docker Setup" = "operations/docker-setup.md" },
    { "Deployment" = "operations/deployment.md" },
    { "Nginx Configuration" = "operations/nginx-configuration.md" },
    { "Monitoring" = "operations/monitoring.md" },
    { "Troubleshooting" = "operations/troubleshooting.md" },
]

[[project.nav]]
"Community" = [
    { "Overview" = "community/" },
    { "Google Summer of Code" = [
        { "Overview" = "community/gsoc/" },
        { "GSoC 2026" = "community/gsoc/2026.md" },
        { "GSoC 2025" = "community/gsoc/2025.md" },
        { "GSoC 2024" = "community/gsoc/2024.md" },
        { "GSoC 2023" = "community/gsoc/2023.md" },
    ]},
    { "Recruitment" = "community/recruitment.md" },
]

[[project.nav]]
"Reference" = [
    { "Overview" = "reference/" },
    { "Glossary" = "reference/glossary.md" },
    { "Supported Languages" = "reference/languages.md" },
    { "Useful Links" = "reference/links.md" },
]


[project.extra]
version = "1.0.0"
alternate = [
    { name = "English", link = "/en/", lang = "en" },
    { name = "Español", link = "/es/", lang = "es" },
    { name = "Português", link = "/pt/", lang = "pt" },
    { name = "Português (Brasil)", link = "/pt-BR/", lang = "pt-BR" },
]