Astro-star

An open-source Astro theme that brings blogs, notes, projects, comments, and friend links into one personal site.

English · 简体中文

🤝 Contributing  ·  🐛 Issues  ·  📖 Docs

---

Table of Contents

• Astro-star
  • Table of Contents
  • Project Map
  • Introduction and Deployment
  • Build Together
  • Tech Stack
  • Sites Using This Theme
  • Discussion and Exchange
  • License

Project Map

/
├── public/                 # Static assets, avatars, site icon, article images
├── scripts/                # Config migration, index sync, and build helpers
├── src/
│   ├── components/         # Reusable components
│   ├── config/             # Site, social links, friend links, and search config
│   ├── content/            # blog / note / project / page content collections
│   ├── layouts/            # Page layouts
│   ├── pages/              # Routes and API endpoints
│   ├── scripts/            # Browser-side interaction scripts
│   ├── style/              # Global styles, component styles, design tokens
│   └── utils/              # Markdown, MDX, and shared utilities
├── astro.config.mjs
├── ecosystem.config.cjs
└── package.json

Top-level routes:

Path	Description
/	Home
/about	About
/blog	Blog
/note	Notes
/project	Projects
/links	Friend links

Introduction and Deployment

See Introduction and Deployment of Astro-star.

Build Together

Small contributions are welcome. A clear Issue, a mobile screenshot, a reproducible bug, a more ergonomic component, or a short setup note can all make this theme easier to maintain and reuse.

Before opening a PR, it is recommended to run:

pnpm check
pnpm format:check
pnpm build

See CONTRIBUTING.md for the core rules. The most important ones are: do not hard-code business content in components, keep styles in src/style/, build mobile-first, and never commit secrets.

Tech Stack

Sites Using This Theme

Welcome to use this theme for your personal site! Submit a PR to add your site to the list.

Avatar	Site	Description
	Ethan	Don't stay awake for too long.

Discussion and Exchange

Welcome to participate in discussions, feedback issues, and feature suggestions in the LINUX DO community.

License

Astro-star is open-source under the Apache License 2.0.

---

If you find this project helpful, consider giving it a ⭐ to show your support!