John Lancaster
46 lines
2.3 KiB
Markdown
46 lines
2.3 KiB
Markdown
# Zensical Docs Skill References
|
|
|
|
Use this index to load only the source references needed for the current task.
|
|
|
|
## Zensical Official Docs
|
|
|
|
- New project scaffolding (`uv run zensical new`): https://zensical.org/docs/
|
|
- Home: https://zensical.org/docs/
|
|
- Setup basics: https://zensical.org/docs/setup/basics/
|
|
- Navigation setup: https://zensical.org/docs/setup/navigation/
|
|
- Header setup and announcement bar: https://zensical.org/docs/setup/header/
|
|
- Footer setup: https://zensical.org/docs/setup/footer/
|
|
- Repository and content actions: https://zensical.org/docs/setup/repository/
|
|
- Search setup: https://zensical.org/docs/setup/search/
|
|
- 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
|
|
- Theme extension and overrides: https://zensical.org/docs/customization/#extending-the-theme
|
|
- Language setup: https://zensical.org/docs/setup/language/
|
|
- Logo and icons: https://zensical.org/docs/setup/logo-and-icons/
|
|
- Code blocks and annotations: https://zensical.org/docs/authoring/code-blocks/
|
|
- Content tabs: https://zensical.org/docs/authoring/content-tabs/
|
|
- Footnotes: https://zensical.org/docs/authoring/footnotes/
|
|
- Tooltips: https://zensical.org/docs/authoring/tooltips/
|
|
|
|
## Adjacent Documentation Quality Sources
|
|
|
|
- Divio documentation system: https://documentation.divio.com/
|
|
- Write the Docs guide: https://www.writethedocs.org/guide/
|
|
- Google developer documentation style guide: https://developers.google.com/style
|
|
- Microsoft Writing Style Guide: https://learn.microsoft.com/style-guide/welcome/
|
|
- MDN writing guidelines: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines
|
|
- Diataxis framework: https://diataxis.fr/
|
|
|
|
## Related Tooling References
|
|
|
|
- Markdown guide: https://www.markdownguide.org/
|
|
- Zensical setup and configuration entry point: https://zensical.org/docs/
|
|
- Zensical customization reference: https://zensical.org/docs/customization/
|
|
- mkdocstrings: https://mkdocstrings.github.io/
|
|
|
|
## Skill-Specific Deep Dives
|
|
|
|
- Theme customization, colors, icons: [./theme-customization-and-icons.md](./theme-customization-and-icons.md)
|
|
- Code-heavy docs with mkdocstrings: [./code-heavy-docs-and-mkdocstrings.md](./code-heavy-docs-and-mkdocstrings.md)
|