AstroBlog

astro-theme-aonote — Astro Blog Template

By runsli

A static blog theme for Astro that provides GFM, MathML formulas, Shiki code blocks, archives, tags, and RSS/Atom feeds.

Explore the design

Compare the page layouts and mobile experience. Open any screenshot for a closer look.

3 previews
Desktop homepage1 / 3
Desktop captureTop of page

Actual screenshot captured by the server browser.

All pages & views 3

Screenshots show visual appearance; interactive behavior may differ.

Recorded 2026-10-02View source

What stands out

A quick read of the recorded project description.

01

Supports GFM: tables, task lists, footnotes, definition lists, and callouts

02

Math formulas are output as MathML (temml) and do not depend on KaTeX runtime CSS

03

Shiki code highlighting with support for metadata such as titles, line highlighting, and diff

04

Built-in archives, tags, RSS and Atom feeds, and sitemap

05

Provides light and dark themes and zh-CN / en interface copy

06

Links are handled according to the subpath when deployed under a repository subpath

Template Details

astro-theme-aonote is a static blog theme for Astro. The repository is released under the MIT license, and the demo site is deployed on Vercel. The theme organizes content around Markdown writing: posts go in src/content/posts/, the about page goes in src/content/pages/about.md, and the site title, baseUrl, language, and copyright are configured in src/site.config.ts.

For rendering, the theme supports GFM tables, task lists, footnotes, definition lists, and callouts; math formulas are output as MathML (using temml) and do not depend on KaTeX runtime CSS; code blocks are highlighted by Shiki and support metadata such as titles, line highlighting, and diff. At the site level, it provides archives, tags, RSS and Atom feeds, and a sitemap. The interface includes light and dark themes and two sets of copy for zh-CN / en, and links are handled according to the subpath when deployed under a repository subpath.

Regarding usage constraints, the theme requires Node ≥ 22.12.0 (Astro 6), with Node 22 LTS recommended; the build command is npm run build, the output directory is dist, the repository includes vercel.json (with CSP headers), and Netlify requires the same build command and publish directory. Third-party assets such as demo images, fonts, and icons must be checked against their respective licenses and cannot be judged solely by the code's MIT license; external services such as domains and hosting may incur additional charges.

AstroBlog

Is it right for your project?

Use Cases

  • Writing and publishing a personal technical blog with Markdown
  • Article sites that need to display math formulas and code highlighting
  • Static blogs that want to provide archives, tags, and RSS/Atom feeds
  • Static sites deployed on Vercel or Netlify

Suitable For

  • Developers building static blogs with Astro
  • Content sites that need GFM, MathML, and Shiki code blocks
  • Users who prefer light and dark themes and Chinese/English interface copy
  • Users who accept Node ≥ 22.12.0 and configure site.config.ts according to the documentation

Getting started & customization

Use these recorded setup notes alongside the repository instructions for your chosen version.

  1. 1

    Use the template via npm create astro@latest my-blog -- --template runsli/astro-theme-aonote, or clone the repository and run npm install and npm run dev.

  2. 2

    Set the title, baseUrl, language, and copyright in src/site.config.ts; place posts in src/content/posts/, and the about page is src/content/pages/about.md.

  3. 3

    Requires Node ≥ 22.12.0 (Astro 6), with Node 22 LTS recommended.

  4. 4

    The build command is npm run build, and the output directory is dist; after deployment, change baseUrl to the production URL.

  5. 5

    The repository includes vercel.json (with CSP headers); Netlify uses the same build command and publish directory.

Read repository instructions

License & source material

Usage conditions & limitations

Free to use · keep license notice

This entry covers the free version under the MIT license in the public repository; the free scope is the code of that version and does not mean that external services or third-party assets are free.

Must comply with when using

  • The code of this version may be used, modified, used commercially, and distributed for free.
  • When distributing copies or substantial portions of the code, retain the original author's copyright notice and the complete MIT license notice.
  • The code is provided as is; warranties and limitations of liability are governed by the original license and applicable law.

Additional costs & items to verify

  • Using this theme requires Node.js version 22.12.0 or higher (because it depends on Astro 6), with Node 22 LTS recommended; lower versions cannot run it.
  • Deployment depends on third-party hosting services such as Vercel or Netlify, which may incur fees or require account registration.
  • After deployment, you must manually change baseUrl in src/site.config.ts to the production URL, otherwise site links may be incorrect.
  • Demo images, fonts, icons, and other third-party assets must be checked against their respective licenses and cannot be judged solely by the code's MIT license.
  • External services such as domains, hosting, databases, payments, or AI may incur additional charges.
View Original Text Basis

Permission is hereby granted, free of charge

Original License Text

**Node:** ≥ 22.12.0 (Astro 6). Node 22 LTS is recommended.

Original README

Import the repo on [Vercel](https://vercel.com/new) or [Netlify](https://app.netlify.com/start)

Original README

After deploy, set `baseUrl` in `src/site.config.ts` to your production URL.

Original README
https://github.com/runsli/astro-theme-aonote/blob/main/LICENSEhttps://github.com/runsli/astro-theme-aonote/blob/main/README.md

Compiled by DeepSeek based on repository license and README ·2026-10-02. Results only cover the materials read; dependencies, images, fonts, and subsequent term changes are subject to their respective original texts.

Project checks & description sources

Template Information

Source platforms
GitHub
Documentation and maintenance reference score
More documented · 83 / 100
Technologies
Astro
Website type
Blog
How this score is calculated

Our heuristic uses license records (up to 30), a demo link (12), a preview (10), stars (15), recorded maintenance (15), description completeness (8), feature records (5) and classification data (5). It is not a code, security or performance test, or a Google score. A link does not establish tested functionality.

What to verify for this project

Repository update recorded
2026-07-06
Screenshot last checked
2026-10-02

A demo link is listed. Check it with your own content and viewport sizes; its presence does not confirm that forms, authentication or payments work.

The catalog identifies Astro as the primary stack. Check the actual dependency manifest and lockfile for versions and hosting requirements. These notes use recorded metadata, not a code audit or a deployment test.

Use a selection guide →

How this description was prepared

AI-assisted description based on catalog records and repository material. Repository authors are not automatically the reviewers of this description.

Automatically checked against source and license rules; no manual editorial review.

Inspect the recorded source material

SHA-256: 32c64b3481d45c5c69be5310af0700886de0f612d62c550e819b8fd49ce48c54

2026-10-02T16:48:04.064Z

Source file / repository
# astro-theme-aonote

English | [中文](README.zh-CN.md)

[![Live Demo](https://img.shields.io/badge/demo-live-0ea5e9)](https://astro-theme-aonote.vercel.app)
[![Astro](https://img.shields.io/badge/Astro-6-BC52EE?logo=astro&logoColor=white)](https://astro.build)

**Static blog theme for [Astro](https://astro.build) 6** — GFM, MathML math, Shiki code blocks, archive, tags, and RSS/Atom.

| | |
| --- | --- |
| **Live demo** | https://astro-theme-aonote.vercel.app |
| **Upstream** | https://github.com/runsli/Aonote |

## Screenshots

| Homepage — recent posts, tag cloud, dark/light | Post page — TOC, MathML, syntax-highlighted code |
| --- | --- |
| ![Homepage showing post list, tags, and theme toggle](docs/screenshots/home.png) | ![Post with table of contents sidebar, math equations, and code blocks](docs/screenshots/post.png) |

## Features

- GFM: tables, task lists, footnotes, definition lists, admonitions
- Math as **MathML** (temml), no KaTeX runtime CSS
- Shiki code blocks with Aonote-style metadata (title, line highlight, diff)
- Archive, tags, RSS + Atom, sitemap
- Light / dark theme, zh-CN / en UI strings
- Subpath-aware links when deployed under a repo path

## Quick start

### Use as Astro template (recommended)

```bash
npm create astro@latest my-blog -- --template runsli/astro-theme-aonote
cd my-blog
npm install
npm run dev
```

### Clone this repo

```bash
git clone https://github.com/runsli/astro-theme-aonote.git
cd astro-theme-aonote
npm install
npm run dev
```

Open http://localhost:4321 and edit:

1. `src/site.config.ts` — title, `baseUrl`, language, copyright
2. `src/content/posts/` — your Markdown posts
3. `src/content/pages/about.md` — about page

**Node:** ≥ 22.12.0 (Astro 6). Node 22 LTS is recommended.

## Deploy

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frunsli%2Fastro-theme-aonote)

1. Import the repo on [Vercel](https://vercel.com/new) or [Netlify](https://app.netlify.com/start) (or use the button above).
2. **Build:** `npm run build` · **Output:** `dist` (framework preset: Astro).
3. After deploy, set `baseUrl` in `src/site.config.ts` to your production URL.

`vercel.json` is included (CSP headers). For Netlify: same build command and publish directory.

To fork via GitHub: enable **Template repository** under repo Settings, then **Use this template** or `npm create astro@latest -- --template runsli/astro-theme-aonote`.

## Customize

| What | Where |
| --- | --- |
| Site title, URL, locale | `src/site.config.ts` |
| UI strings | `src/i18n.ts` |
| Global layout / nav | `src/layouts/BaseLayout.astro` |
| Theme CSS | `src/styles/aonote.css` |
| Markdown pipeline | `src/integrations/aonote-markdown.ts` |
| Feed limits | `src/utils/feed.ts` |
| `robots.txt` / sitemap URL | `src/pages/robots.txt.ts` (uses `site.config.ts`) |

## Project layout

```text
src/
├── site.config.ts
├── content/
│   ├── posts/          # Blog articles
│   └── pages/          # about, 404
├── layouts/
├── components/
├── pages/              # Routes
├── integrations/       # Markdown / Shiki
└── styles/aonote.css
```

## Scripts

| Command | Action |
| --- | --- |
| `npm run dev` | Dev server |
| `npm run build` | Production build → `dist/` |
| `npm run preview` | Preview build |
| `npm run check` | `astro check` |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

MIT — see [LICENSE](LICENSE). Original Aonote design and styles © [runsli](https://github.com/runsli).
Report a correction

Explore similar templates

Compare previews and descriptions within the same stack and category.