Zensical Theme Slate

slate-theme is a sleek, developer-focused, and highly interactive bilingual portfolio and blog theme packaged for Zensical (the modern, Rust-powered static site generator built on top of MkDocs).

This package contains the core compiled design assets and templates so you can apply the polished Slate Theme directly to any existing Zensical website with zero-configuration setup.

🌟 Key Theme Features

• Sleek Slate Aesthetics: Deep graphite base (#0b0f19) and tailored indigo/slate accents for a premium technical look.
• Interactive Neural Background: Canvas particle system connecting nodes with lines that respond smoothly to mouse movements.
• Circular Page Ripple: A gorgeous ripple transition triggered when toggling light/dark modes (fully respects prefers-reduced-motion).
• 3D Glare Tilt Cards: Project and experience cards that tilt dynamically in response to mouse coordinates with a glassmorphism reflection overlay.
• Zero-Configuration Asset Injection: Automated asset injection via layout overrides, loading styles and scripts natively without configuration boilerplate.

🚀 Installation & Usage

You can apply the Slate theme to your Zensical project in two simple steps:

1. Install the Package

Add the package to your project's virtual environment using uv (recommended):

uv add slate-theme

Or using standard pip:

pip install slate-theme

2. Configure Your Theme

Update your zensical.toml (and zensical.es.toml if your site is bilingual) to load the packaged theme:

[project.theme]
name = "slate"

[!NOTE] Zero-Configuration Setup: You do NOT need to declare extra_css or extra_javascript configurations in your site configuration file to load the theme's core stylesheets and scripts. The package handles this natively via layout template inheritance.

🎨 Starter Template

If you are starting a new website from scratch, this repository also serves as a complete Bilingual Starter Pack.

Instead of configuring everything manually, you can use the pre-configured starter layout, multi-language structure (English and Spanish), and automated deployment workflows.

Visit the Official GitHub Repository for cloning instructions, manual setup steps, and the full bilingual customization guide.

📄 License

To maintain a clear boundary between the open-source engine and the theme's core assets or template content, this repository operates under a dual-license model:

• Source Code (pyproject.toml, .github/, scripts, tooling configurations) is released under the MIT License.
• Starter Template Content (Markdown files under content/, default demo images, and placeholder prose) is released under the Creative Commons Attribution 4.0 International License (CC-BY-4.0).