Skip to content
Starlight GitHub Pages Action
GitHub
This is a banner — used for announcements and important notices.

Component Showcase

This page demonstrates all the custom theme components.

Typography

Section titled “Typography”

Third-level heading

Section titled “Third-level heading”

Fourth-level heading

Section titled “Fourth-level heading”

Regular paragraph text with bold, italic, inline code, and a link.

Blockquotes look like this. Useful for callouts and important notes.

Code Blocks

Section titled “Code Blocks”
name: Deploy Documentation
on:
  push:
    branches: [main]


jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: myerscode/starlight-github-pages-action@main
        with:
          site-title: "My Docs"
interface Config {
  siteTitle: string;
  contentDir?: string;
  changelog?: 'auto' | 'false' | string;
}


function deploy(config: Config): Promise<void> {
  return buildAndDeploy(config);
}

Tables

Section titled “Tables”
Input Description Default
site-title Documentation site title —
content-dir Content directory docs
changelog Changelog handling auto
base-path Deployment base path auto-detected

Lists

Section titled “Lists”

Unordered

Section titled “Unordered”
  • Sidebar with icons and collapsible groups
  • Light/dark/system theme toggle
  • Prev/next pagination cards
    • With directional arrows
    • Styled borders and hover states
  • Full-text search via Pagefind

Ordered

Section titled “Ordered”
  1. Enable GitHub Pages in repo settings
  2. Create the workflow file
  3. Add markdown content to docs/
  4. Push to trigger deployment

Horizontal Rule

Section titled “Horizontal Rule”

Admonitions

Section titled “Admonitions”