Home

AstroPaper Wiki

AstroPaper is a minimal, responsive, accessible, and SEO-friendly Astro blog theme. This wiki is the official documentation for AstroPaper v6.

Features

• Type-safe markdown and MDX support
• Super fast performance (near-perfect Lighthouse scores)
• Accessible (keyboard and screen reader friendly)
• Responsive across mobile and desktop
• SEO-optimized (canonical URLs, Open Graph, Twitter cards, sitemap, RSS)
• Light and dark mode with system preference detection
• Static full-text search powered by Pagefind
• Draft posts and pagination
• Dynamic OG image generation per post
• Collapsible table of contents
• Archives page and tag pages
• Callouts/admonitions with collapsible support
• Accessible image lightbox
• Share links on post pages
• Configurable "Edit page" link
• i18n-ready date formatting with per-post timezone support
• RTL language direction support

Quick Start

Requirements: Node.js ≥ 22.12.0, pnpm recommended.

# Create a new project from the template
pnpm create astro@latest --template satnaing/astro-paper

# Install dependencies
pnpm install

# Start the dev server
pnpm dev

The dev server starts at http://localhost:4321.

Navigation

Page	Description
Getting Started	Installation, project structure, first steps
Configuration	Full reference for astro-paper.config.ts
Writing Posts	Frontmatter fields, MDX, images, callouts, TOC
Customization	Colors, fonts, logo, layout width
Features	Overview of all built-in features
Deployment	Vercel, Netlify, GitHub Pages, Cloudflare, Docker
Integrations	Giscus comments, LaTeX/KaTeX, analytics
i18n	Date formatting, locale, translations
Upgrading	Updating dependencies and the template

Links

• Live demo: https://astro-paper.pages.dev/
• GitHub: https://github.com/satnaing/astro-paper
• Figma design: https://www.figma.com/community/file/1356898632249991861
• License: MIT