Skip to content

feat: add Zensical documentation site#12

Merged
trisdoan merged 1 commit into
mainfrom
feat/add-docs-site
May 11, 2026
Merged

feat: add Zensical documentation site#12
trisdoan merged 1 commit into
mainfrom
feat/add-docs-site

Conversation

@trisdoan
Copy link
Copy Markdown
Collaborator

@trisdoan trisdoan commented Apr 1, 2026

Summary

Adds a full documentation site built with Zensical (Material for MkDocs). Includes landing page with Three.js wave animation, comprehensive guides (getting started, supported layouts, API reference), and contributor documentation. Site includes GA4 analytics integration and custom Trobz dark theme.

Changes

  • site-docs/zensical.toml — Site configuration with nav structure and theme
  • site-docs/docs/ — Markdown source files:
    • index.md — Landing page
    • getting-started.md, supported-layouts.md, api-reference.md, contributing.md
    • javascripts/hero-scene.js — Three.js wave animation for hero section
    • javascripts/commit-count.js — Dynamic GitHub commit badge
    • stylesheets/hero.css, site.css — Trobz dark theme + hero styles
  • site-docs/overrides/ — HTML template overrides:
    • landing.html — Full-viewport hero landing page
    • main.html — GA4 analytics injection
  • site-docs/site/ — Pre-built static site (HTML, assets, search index)
  • pyproject.toml + uv.lock — Add zensical as dev dependency

Test Plan

  • Build site locally: cd site-docs && zensical build
  • Verify landing page renders with wave animation
  • Check all guide pages load correctly
  • Verify search index is populated
  • Test responsive design on mobile view
  • Confirm GA4 analytics script is present in HTML

@trisdoan trisdoan force-pushed the feat/add-docs-site branch from d22937f to ead35dd Compare April 14, 2026 08:25
@nilshamerlinck
Copy link
Copy Markdown
Contributor

looking good, ready for deployment?

Add comprehensive documentation site under site-docs/ with:
- Landing page with Three.js wave animation and GitHub commit badge
- Getting started, supported layouts, API reference, contributing guides
- Custom Trobz dark theme with hero styling
- GA4 analytics integration via main.html override
- Full static site build output (HTML, CSS, JS, search index)

Also add zensical as dev dependency for documentation generation.
@trisdoan trisdoan force-pushed the feat/add-docs-site branch from ead35dd to 26e0781 Compare May 8, 2026 09:05
@trisdoan
Copy link
Copy Markdown
Collaborator Author

trisdoan commented May 8, 2026

Hi anh @nilshamerlinck , I just improved landing page and content a bit

image

@trisdoan trisdoan marked this pull request as ready for review May 8, 2026 09:06
@trisdoan trisdoan merged commit 6ac6aa2 into main May 11, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants