2.4 KiB
2.4 KiB
Zensical Features and Configuration Patterns
Use this reference when deciding which Zensical features to enable and why.
High-Value Feature Groups
Navigation and Discoverability
navigation.indexes: lets sections have index pages for overview content.navigation.path: adds breadcrumb-like context.navigation.sections: groups top-level sections for large doc sets.navigation.instant: enables instant internal navigation.navigation.instant.prefetch: prefetches likely next pages.navigation.top: shows a back-to-top affordance.navigation.tracking: keeps URL anchors in sync with active section.
Source links:
Code-Heavy Documentation
content.code.copy: copy button in code blocks.content.code.select: line range selection support.content.code.annotate: inline code annotations.
Source links:
Cross-Page UX Consistency
content.tabs.link: keeps same-named tabs synchronized.content.tooltips: improves tooltip behavior for links.content.footnote.tooltips: inline footnote previews.
Source links:
- https://zensical.org/docs/authoring/content-tabs/
- https://zensical.org/docs/authoring/tooltips/
- https://zensical.org/docs/authoring/footnotes/
Search and Content Actions
search.highlight: highlights matches after search navigation.content.action.editandcontent.action.view(if repository integration is configured).
Source links:
Styling and Extensibility
Use site-level customization when docs need stronger visual affordances.
extra_css: add targeted style overrides.extra_javascript: add behavior enhancements.- Theme override directory (
custom_dir) for template-level changes.
Source links:
- https://zensical.org/docs/customization/
- https://zensical.org/docs/customization/#additional-css
- https://zensical.org/docs/customization/#additional-javascript
- https://zensical.org/docs/customization/#extending-the-theme
Practical Feature Selection Rules
- Start with discoverability and clarity features first.
- Add convenience features (copy/select/tooltips) when content type supports them.
- Avoid enabling many features at once without measurement.
- Track user success metrics (search success, time-to-answer, support deflection) after each change.