pub struct DocsConfig {
pub title: Option<String>,
pub source_url: Option<String>,
pub home_url: Option<String>,
pub home_title: Option<String>,
pub stylesheet: Option<String>,
pub color_scheme: Option<ColorScheme>,
pub scheme_toggle: Option<bool>,
pub viewer: Option<bool>,
}Expand description
What asbuilt docs cannot read off the code.
Fields§
§title: Option<String>The site title; the root directory’s name when absent.
source_url: Option<String>A URL prefix that turns a repo-relative path into a link, e.g.
https://github.com/owner/repo/blob/main/. Paths stay plain text
when absent.
home_url: Option<String>A link back to the site that hosts the tree, first in every
page’s header trail; relative values (../) resolve
from each page’s depth. No link when absent.
home_title: Option<String>The text of that link; the URL itself when absent. Every page’s
<title> starts with it.
stylesheet: Option<String>A stylesheet linked last in every page, after the tree’s own, so
the host can restate the page tokens in its palette. Resolved
like home_url.
color_scheme: Option<ColorScheme>The scheme the pages show before a visitor chooses one; the system’s setting when absent.
scheme_toggle: Option<bool>Whether every page carries a System / Light / Dark control, and
with it theme.js. On when absent.
viewer: Option<bool>Whether every inlined view gets the viewer (viewer.js): a frame
at a readable scale with Fit, 1:1, Wide, Legend and Fullscreen
controls.
On when absent.