Verified:GitHub

zensical-setup

Automate Zensical documentation site setup, configuration, and deployment to GitHub Pages and GitLab Pages.

14|1|Updated Mar 26, 2023

Search Tags:#theming #documentation #deployment #navigation #setup #mkdocs #zensical

One-click install

npx skills add https://github.com/ML4GLand/SeqPro --skill zensical-setup-ml4gland

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: zensical-setup
Source: https://github.com/ML4GLand/SeqPro/tree/main/.claude/skills/zensical-setup
Command: npx skills add https://github.com/ML4GLand/SeqPro --skill zensical-setup-ml4gland

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Solves the initial setup and ongoing configuration of Zensical documentation sites, reducing manual setup time and ensuring consistent project scaffolding across repositories.

Core Features & Use Cases

Automated project initialization with a standard configuration (zensical.toml) and support for mkdocs.yml migration.
Theme customization, navigation setup, font configuration, and deployment workflows for GitHub Pages and GitLab Pages.
Use Case: Create a new docs site for a project and push to a hosting service with a consistent look and structure.

Quick Start

Create a new project with zensical new and then run zensical serve to preview 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 and deploy a Zensical documentation site?▼

To set up a Zensical documentation site, initialize a new project with a standard configuration file, configure theming and navigation, then deploy it directly to GitHub Pages or GitLab Pages using automated workflows.

Can I migrate an existing mkdocs.yml configuration to Zensical?▼

Yes, you can migrate an existing mkdocs.yml configuration to Zensical. The setup workflow supports mkdocs.yml migration to transition your documentation structure into the standard zensical.toml format.

How do I customize fonts and themes for Zensical docs?▼

Customizing fonts and themes for Zensical docs involves applying theme variants and font configurations during project initialization. The setup workflow automates per-project customization for a consistent look.

Does Zensical support deployment to both GitHub Pages and GitLab Pages?▼

Yes, Zensical supports deployment to both GitHub Pages and GitLab Pages. The setup workflow configures the necessary deployment pipelines to host your documentation site on either platform.

What is the best way to structure navigation for a Zensical documentation site?▼

The best way to structure navigation for a Zensical documentation site is through the automated navigation setup feature. It configures your site hierarchy during initialization to ensure consistent project scaffolding across repositories.

Do I need YAML frontmatter for Zensical documentation setup?▼

Yes, YAML frontmatter is required for Zensical documentation setup. The configuration workflow satisfies YAML frontmatter-driven metadata requirements to properly structure and organize your documentation pages.