What MiniWiki is and how to use this documentation.

Essential

Social

Home

Introduction

Quickstart

Architecture

Components

JSON Reference

Understand how MiniWiki is structured end-to-end.

Codebase Architecture

Collapsible content panels for FAQs and dense docs.

Accordion

Highlight critical info with semantic variants.

Alert

Compact status labels for metadata and tags.

Badge

ButtonLink

Emphasized content block with icon support.

Callout

CardGrid

Structured content container with title and description.

Card

Smooth area chart for trend-heavy visual storytelling.

AreaChart

Lightweight vertical bar chart rendered with divs.

BarChart

Segmented donut chart with optional legend.

DonutChart

Matrix-based heatmap for intensity comparisons across dimensions.

HeatmapChart

Data-visualization components grouped under components/charts.

Charts Index

ProgressRingChart

SparklineChart

Compare grouped totals and composition with stacked segments.

StackedBarChart

Syntax-highlighted fenced code with copy support.

CodeBlock

DarkModeToggle

Render glossary-style term-definition pairs.

DefinitionList

Visual separator between content sections.

Divider

Uniform list UI for capability summaries.

FeatureList

Figure

Footer

Header

Named icon wrapper powered by lucide-react.

Icon

Complete reference for every MiniWiki component.

Components Index

Wikipedia-style summary panel with key facts.

Infobox

Month-grid and agenda calendar component for schedules and appointments.

Calendar

Flashcards

Interactive components for engagement-focused pages and blogs.

Interactive Index

OpenStreetMap map component with support for public or self-hosted tiles.

Lightweight vote-and-visualize poll component.

Poll

Multiple-choice quiz component for learning and blog interactivity.

Quiz

Structured formula catalog with names and rendered expressions.

FormulaList

Math-focused components powered by KaTeX and reusable formula UIs.

Math Index

Render inline or block LaTeX expressions with KaTeX.

MathEquation

Step-by-step derivation component with KaTeX-rendered equations.

MathSteps

Built-in length unit converter for educational and science pages.

UnitConverter

Central mapping that exposes components to MDX.

mdx-components Registry

Search pre-defined card results with metadata and tags.

PresetSearch

Visual composition panel for molecules and compounds.

CompoundBreakdown

Card-style scientific element display for chemistry content.

ElementCard

Science-oriented components for technical and educational sites.

Science Index

Compact periodic-table component for science and STEM content.

PeriodicTable

SearchBar

Hierarchical documentation navigation component.

Sidebar

Ordered procedural steps with clear progression.

Steps

Tabbed content UI for grouped alternatives.

Tabs

Full table primitives for advanced tabular docs.

WikiTable

Understand how files map to routes in MiniWiki.

Content Structure

Full key reference for footer columns and legal links.

footer.json Reference

Full key reference for top navigation links.

header.json Reference

Complete key-by-key reference for all MiniWiki JSON config files.

JSON Reference Index

Full key reference for sidebar section hierarchy.

sidebar.json Reference

Full key reference for global site configuration.

site.json Reference

Full key reference for page-template defaults and registry.

templates.json Reference

Replaced by full key-by-key JSON references.

Navigation JSON

Recommended Git workflow for wiki content changes.

Publishing Workflow

Site Config

Apply a full-site look with wiki presets.

Theming and Presets

Fix common MiniWiki setup and rendering problems.

Troubleshooting

Best practices for writing high-quality docs in MiniWiki.

Writing Guidelines

Official documentation for the MiniWiki template.

Introduction #

What MiniWiki is for #

Prerequisites and setup #

How this documentation is organized #