wiki-writing

Standardize Oxidus wiki page creation with frontmatter, layout, and component rules.

8|3|Updated Sep 29, 2021
One-click install
npx skills add https://github.com/gesslar/oxidus-mudlib --skill wiki-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: wiki-writing
Source: https://github.com/gesslar/oxidus-mudlib/tree/main/.claude/skills/wiki-writing
Command: npx skills add https://github.com/gesslar/oxidus-mudlib --skill wiki-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide standardizes the creation of Oxidus wiki pages by outlining structure, spelling, and formatting rules that ensure consistency across the documentation.

Core Features & Use Cases

  • User-facing writing guidelines for Starlight/MDX wiki pages, including Canadian English spelling, frontmatter requirements, and content organization.
  • Instructions for proper file locations, markup blocks, code components, and how to integrate Markdown and MDX with wiki components.
  • Use Case: An author creates a new wiki page about a system feature, following the frontmatter, table of contents, and component usage rules to ensure consistent rendering.

Quick Start

Start by creating a new wiki page with YAML frontmatter defining a title and description, then populate content that follows the documented structure.

Frequently Asked Questions about wiki-writing

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

FAQPage Schema
How do I structure frontmatter for Starlight wiki pages?

Starlight wiki pages require YAML frontmatter defining a title and description at the top of the Markdown or MDX file. This standardizes metadata for consistent rendering and indexing across the documentation site.

What are the spelling rules for writing markdown documentation?

Markdown documentation for the Oxidus wiki must use Canadian English spelling to maintain consistency across all pages. This rule applies to the full text content within the MDX and Markdown files.

How do I add code blocks and images to MDX documentation?

MDX documentation supports standard Markdown markup blocks for code and images, alongside Starlight component integration. Proper file locations and component usage rules ensure the assets render correctly within the wiki.

Can I use Astro components inside my markdown wiki content?

Yes, you can integrate Starlight and Astro components directly within MDX wiki content. The wiki writing guidelines cover how to combine Markdown formatting with these components for enhanced documentation features.

How do I organize wiki page files to ensure consistent rendering?

Wiki page files must follow documented file organization rules to ensure consistent rendering across the Starlight-based documentation site. Proper directory placement and frontmatter structure are enforced for all contributed pages.

What should I include in a new Starlight wiki page?

A new Starlight wiki page should include YAML frontmatter with a title and description, a structured table of contents, organized content sections, and properly formatted code blocks or images following the established guidelines.