From b93d630c0a8d860e534cea19a0718af0917cfb5a Mon Sep 17 00:00:00 2001 From: Martin Donath Date: Thu, 26 Feb 2026 12:58:30 +0100 Subject: [PATCH] fix: clarify examples in bootstrapped `zensical.toml` (#394) Signed-off-by: squidfunk --- python/zensical/bootstrap/zensical.toml | 60 ++++++++++++------------- 1 file changed, 29 insertions(+), 31 deletions(-) diff --git a/python/zensical/bootstrap/zensical.toml b/python/zensical/bootstrap/zensical.toml index b8abbb3..9d90b6a 100644 --- a/python/zensical/bootstrap/zensical.toml +++ b/python/zensical/bootstrap/zensical.toml @@ -249,6 +249,35 @@ features = [ #"toc.integrate", ] +# ---------------------------------------------------------------------------- +# You can configure your own logo to be shown in the header using the "logo" +# option in the "theme" subsection. The logo must be a relative path to a file +# in your "docs_dir", e.g., to use `docs/assets/logo.png` you would set: +# ---------------------------------------------------------------------------- +#logo = "assets/logo.png" + +# ---------------------------------------------------------------------------- +# If you don't have a dedicated project logo, you can use a built-in icon from +# the icon sets shipped in Zensical. Please note that the setting lives in a +# differernt subsection, and that the above take precedence over the icon. +# +# Read more: +# - https://zensical.org/docs/setup/logo-and-icons +# - https://github.com/zensical/ui/tree/master/dist/.icons +# ---------------------------------------------------------------------------- +#[project.theme.icon] +#logo = "lucide/smile" + +# ---------------------------------------------------------------------------- +# In the "font" subsection you can configure the fonts used. By default, fonts +# are loaded from Google Fonts, giving you a wide range of choices from a set +# of suitably licensed fonts. There are options for a normal text font and for +# a monospaced font used in code blocks. +# ---------------------------------------------------------------------------- +#[project.theme.font] +#text = "Inter" +#code = "Jetbrains Mono" + # ---------------------------------------------------------------------------- # In the "palette" subsection you can configure options for the color scheme. # You can configure different color # schemes, e.g., to turn on dark mode, @@ -268,40 +297,9 @@ scheme = "slate" toggle.icon = "lucide/moon" toggle.name = "Switch to light mode" -# ---------------------------------------------------------------------------- -# In the "font" subsection you can configure the fonts used. By default, fonts -# are loaded from Google Fonts, giving you a wide range of choices from a set -# of suitably licensed fonts. There are options for a normal text font and for -# a monospaced font used in code blocks. -# ---------------------------------------------------------------------------- -#[project.theme.font] -#text = "Inter" -#code = "Jetbrains Mono" - -# ---------------------------------------------------------------------------- -# You can configure your own logo to be shown in the header using the "logo" -# option in the "icons" subsection. The logo can be a path to a file in your -# "docs_dir" or it can be a path to an icon. -# -# Likewise, you can customize the logo used for the repository section of the -# header. Zensical derives the default logo for this from the repository URL. -# See below... -# -# There are other icons you can customize. See the documentation for details. -# -# Read more: -# - https://zensical.org/docs/setup/logo-and-icons -# - https://zensical.org/docs/authoring/icons-emojis/#search -# ---------------------------------------------------------------------------- -#[project.theme.icon] -#logo = "lucide/smile" -#repo = "lucide/smile" - # ---------------------------------------------------------------------------- # The "extra" section contains miscellaneous settings. # ---------------------------------------------------------------------------- #[[project.extra.social]] #icon = "fontawesome/brands/github" #link = "https://github.com/user/repo" - -