zensical

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 24, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package zensical defines site configuration constants for Zensical and MkDocs integration.

Index

Constants

View Source
const (
	// MkDocsAdmonitionPrefix is the prefix for admonition lines in MkDocs.
	MkDocsAdmonitionPrefix = "!!!"
	// MkDocsTabPrefix is the prefix for tab marker lines in MkDocs.
	MkDocsTabPrefix = "=== "
	// MkDocsIndent is the 4-space indentation used in admonition/tab bodies.
	MkDocsIndent = "    "
	// MkDocsIndentWidth is the number of characters to dedent from body lines.
	MkDocsIndentWidth = 4
	// MkDocsFrontmatterDelim is the YAML frontmatter delimiter.
	MkDocsFrontmatterDelim = "---"
)

MkDocs stripping constants (used by "ctx why" to clean embedded docs).

View Source
const (
	// TomlNavOpen is the opening bracket for the TOML nav array.
	TomlNavOpen = "nav = ["
	// TomlNavSectionClose closes a nav section group.
	TomlNavSectionClose = "  ]}"
	// TomlNavClose closes the top-level nav array.
	TomlNavClose = "]"
)
View Source
const (
	// Toml is the zensical site configuration filename.
	Toml = "zensical.toml"
	// Bin is the zensical binary name.
	Bin = "zensical"
	// Stylesheets is the subdirectory for CSS stylesheets in site output.
	Stylesheets = "stylesheets"
	// ExtraCSS is the custom CSS filename for journal sites.
	ExtraCSS = "extra.css"
	// CmdServe is the zensical serve subcommand.
	CmdServe = "serve"
	// CmdBuild is the zensical build subcommand.
	CmdBuild = "build"
)

Zensical site configuration.

Note that both the journal site and the main docs site share the same config settings.

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL