skills.rest
stencila
stencilaOFFICIAL
Explore all skills by this author →
WebsiteGitHub

site-config-creation

Create and update the [site] section of stencila.toml for published Stencila sites.

902|58|Updated May 31, 2012
Search Tags:#routes#TOML#documentation site#stencila#site configuration#Navigation#Layout
One-click install
npx skills add https://github.com/stencila/stencila --skill site-config-creation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: site-config-creation
Source: https://github.com/stencila/stencila/tree/main/.stencila/skills/site-config-creation
Command: npx skills add https://github.com/stencila/stencila --skill site-config-creation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Configuring a published Stencila site requires knowing dozens of TOML fields across many subsections, and manual edits risk invalid syntax, lost comments, or broken layouts. This Skill guides the creation and editing of the [site] section of stencila.toml with validation and visual verification.

Core Features & Use Cases

  • Full site configuration coverage: Handles domain, title, author, logo, navigation, routes, redirects, access control, layout presets and regions, search, socials, reviews, uploads, remotes, and more.
  • Safe TOML editing: Reads the existing stencila.toml first, preserves comments and unrelated sections, and validates changes with stencila config check and stencila config show.
  • Visual verification: Uses the snap tool to confirm layout, navigation, and component changes render correctly when a Stencila server is running.
  • Use Case: A documentation team wants a landing page at the root with a docs layout under /docs/, plus search and GitHub social links. The Skill generates the correct layout overrides, enables search, and validates the result.

Quick Start

Ask the assistant to configure your Stencila site, for example: set up stencila.toml with a docs layout preset, site search, and a redirect from /old-docs/ to /docs/.

Frequently Asked Questions about site-config-creation

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

FAQPage Schema
How do I configure the [site] section in stencila.toml?▼

Set top-level fields like domain, title, author, and logo directly under [site], then add subsections such as [site.layout], [site.routes], and [site.access] as needed. Validate the result with stencila config check and inspect resolved values with stencila config show.

How do I add a redirect in a Stencila site configuration?▼

Add an entry to [site.routes] mapping the old route to an inline table with redirect and status, for example "/old-path/" = { redirect = "/new-path/", status = 301 }. Route keys must start and end with a forward slash.

Can I use different layout presets for different routes in Stencila?▼

Yes, set a default preset in [site.layout] and add [[site.layout.overrides]] entries with routes patterns and a different preset. For example, use landing at the root and docs for everything under /docs/.

Why do reviews, uploads, and remotes not work in my Stencila site?▼

These interactive features require workspace.id to be set in stencila.toml. Add a [workspace] section with an id field, then enable the features with simple boolean form or detailed tables for fine-grained control.

How do I verify Stencila site layout changes visually?▼

Use the snap tool against a running Stencila server to capture rendered pages after layout or navigation changes. Index-like files such as index.md, main.md, and README.md render at their directory route, so docs/README.md appears at /docs/.

Related Skills

Explore More Software Engineering Skills→
stencilastencila
900

theme-creation

Create, update, and plan Stencila themes for documents, sites, plots, and PDF outputs.

Official
Advanced
gologiusgologius

skill

Organize website markdown, YAML configurations, and media assets into structured summaries.

Community
Intermediate
soo-kate-yeonsoo-kate-yeon

moai-docs-generation

Generate API documentation from source code and OpenAPI specifications.

Community
Advanced
avibe-botavibe-bot
491

use-avibe

Manage local Avibe configurations, routing, tasks, and remote access.

Official
Advanced