se-kernel/zensical.toml at main · structural-explainability/se-kernel · 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
# ============================================================
# zensical.toml (Zensical configuration file)
# ============================================================
# WHY: Centralizes project documentation configuration.

[project]
site_name = "SE Kernel"
site_url = "https://structural-explainability.github.io/se-kernel/"
repo_url = "https://github.com/structural-explainability/se-kernel"
repo_name = "structural-explainability/se-kernel"
site_description = "Project documentation"
docs_dir = "docs" # source directory for documentation markdown files
site_dir = "site" # output directory for generated site (ignored by Git; not in repo)
edit_uri = "edit/main/docs/" # "Edit this page" links (GitHub)

[project.extra]
# WHY: Social links provide easy access to project repositories and profiles.
social = [
    {icon = "fontawesome/brands/github", link = "https://github.com/structural-explainability/se-kernel" },
]

# ------------------------------------------------------------
# Plugins
# ------------------------------------------------------------
[project.plugins.search]
lang = "en" # WHY: Search plugin provides instant search functionality for documentation.

[project.theme]
# SEE: https://zensical.org/docs/setup/navigation/#instant-navigation-zensicaltoml
features = [
    "navigation.tracking", # WHY: Tracking allows for analytics on how users interact with the documentation, which can inform improvements.
    "navigation.expand", # WHY: Expandable navigation allows users to focus on relevant sections while keeping the overall structure accessible.
    "navigation.path", # WHY: Path navigation helps users understand their location within the documentation hierarchy.
    "navigation.prune", # WHY: Pruning simplifies navigation by hiding irrelevant sections based on the current page.
    "navigation.indexes", # WHY: Indexes provide an overview of the documentation structure and allow for quick access to different sections.
    "toc.follow", # WHY: Following the table of contents enhances user experience by keeping the navigation in sync with the current page.
    "toc.integrate", # WHY: Integrating the table of contents into the navigation provides a more cohesive and user-friendly interface.
    "navigation.top",# WHY: A "Back to top" button improves usability by allowing users to quickly return to the top of the page.
]

# ------------------------------------------------------------
# Navigation
# ------------------------------------------------------------
# No explicit nav.
# Let Zensical build navigation from folder structure.