zensical-setup

Configure Zensical documentation sites via TOML and deploy to GitHub or GitLab Pages.

17|2|Updated Jun 5, 2025

Search Tags:#documentation #deployment #configuration #mkdocs #zensical #site generator

One-click install

npx skills add https://github.com/AI-Riksarkivet/ra-mcp --skill zensical-setup

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: zensical-setup
Source: https://github.com/AI-Riksarkivet/ra-mcp/tree/main/.claude/skills/zensical-setup
Command: npx skills add https://github.com/AI-Riksarkivet/ra-mcp --skill zensical-setup

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill simplifies the process of setting up and configuring Zensical documentation sites, enabling users to quickly create and customize project documentation.

Core Features & Use Cases

Site Generation: Create new Zensical projects and serve them locally for preview.
Configuration Management: Guide users through zensical.toml settings for themes, navigation, fonts, and colors.
Deployment Assistance: Provide examples for deploying documentation sites via GitHub Pages and GitLab Pages.
Use Case: A software engineer needs to create a new documentation site for their open-source project. They can use this Skill to get started with the basic setup, configure the theme to match their project's branding, and set up a navigation structure.

Quick Start

Use the zensical setup skill to create a new documentation site and serve it locally.

Frequently Asked Questions about zensical-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I set up a Zensical documentation site locally?▼

To set up a Zensical documentation site, you create a new project and serve it locally for preview. This process simplifies initial project creation and allows you to view changes before deployment.

How do I configure themes and navigation in zensical.toml?▼

You configure themes, navigation, fonts, and colors by editing the zensical.toml file. This configuration management step allows you to customize the site's appearance and structure to match your project's branding.

Can I deploy Zensical documentation to GitHub and GitLab Pages?▼

Yes, you can deploy Zensical documentation sites via GitHub Pages and GitLab Pages. The setup provides deployment assistance and examples to help you publish your configured site to either platform.

What is the best way to customize fonts and colors for a documentation site?▼

The best way to customize fonts and colors for a documentation site is through TOML configuration. By adjusting the settings in your configuration file, you can align the site's theme with your project's visual identity.

Do I need MkDocs to build and serve a Zensical site?▼

Zensical operates as a site generator that handles the build processes and local serving. You can use it to generate and preview your documentation without needing separate site generator tools.

Why use a site generator for project documentation instead of static files?▼

Using a site generator for project documentation streamlines the build process and local serving. It enables structured navigation, theme configuration, and automated deployment to platforms like GitHub Pages, which static files alone do not provide.