formatting

This commit is contained in:
John Lancaster
2026-06-19 01:29:05 -05:00
parent 964cd6f76d
commit 3347443ca9
27 changed files with 275 additions and 238 deletions
@@ -21,8 +21,8 @@ Always start a new docs project with `uv run zensical new`.
- `navigation.top`: shows a back-to-top affordance.
- `navigation.tracking`: keeps URL anchors in sync with active section.
Source links:
- https://zensical.org/docs/setup/navigation/
!!! info "Source links"
- [Zensical navigation setup](https://zensical.org/docs/setup/navigation/)
### Code-Heavy Documentation
@@ -32,9 +32,9 @@ Source links:
- Prefer mkdocstrings for generated API reference pages when documenting Python code.
- Keep generated API pages linked from hand-authored task and concept docs.
Source links:
- https://zensical.org/docs/authoring/code-blocks/
- https://mkdocstrings.github.io/
!!! info "Source links"
- [Zensical code blocks](https://zensical.org/docs/authoring/code-blocks/)
- [mkdocstrings](https://mkdocstrings.github.io/)
### Cross-Page UX Consistency
@@ -42,19 +42,19 @@ Source links:
- `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/
!!! info "Source links"
- [Zensical content tabs](https://zensical.org/docs/authoring/content-tabs/)
- [Zensical tooltips](https://zensical.org/docs/authoring/tooltips/)
- [Zensical footnotes](https://zensical.org/docs/authoring/footnotes/)
### Search and Content Actions
- `search.highlight`: highlights matches after search navigation.
- `content.action.edit` and `content.action.view` (if repository integration is configured).
Source links:
- https://zensical.org/docs/setup/search/
- https://zensical.org/docs/setup/repository/
!!! info "Source links"
- [Zensical search setup](https://zensical.org/docs/setup/search/)
- [Zensical repository setup](https://zensical.org/docs/setup/repository/)
## Styling and Extensibility
@@ -64,11 +64,11 @@ Use site-level customization when docs need stronger visual affordances.
- `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
!!! info "Source links"
- [Zensical customization overview](https://zensical.org/docs/customization/)
- [Additional CSS](https://zensical.org/docs/customization/#additional-css)
- [Additional JavaScript](https://zensical.org/docs/customization/#additional-javascript)
- [Extending the theme](https://zensical.org/docs/customization/#extending-the-theme)
## Practical Feature Selection Rules