AstralHalo/README.md

Astral Halo

Warning

This project is still under development and may contain bugs and breaking changes. Use with caution.

Live Demo (Netlify) | English | 简体中文

Astral Halo is a static blog template developed with Astro.

Features/TODO

• Built with Astro and Tailwind CSS (using daisyUI)
• Freely switchable light/dark themes
• Responsive design
• Search functionality (currently only supports Pagefind)
• Responsive article table of contents
• Bidirectional references in articles
• Comments system, supports:
  • Twikoo
  • Giscus
  • Waline
  • Artalk
• Various components that can be used in articles
• Smooth animations and page transitions
• Useful JS script tools
• PWA supports

Getting Started

1. Use this template to generate a new repository or fork this repository.

2. For local development, clone the repository, run pnpm install to install dependencies, and pnpm dev to start the development server.

   • If pnpm is not installed, first run npm install -g pnpm to install it.

3. Customize your blog through the configuration file src/config.ts. Configuration documentation can be found in the comments of src/types/config.ts.

4. Run pnpm new [draft|post] [title] to create a new article. If creating a draft, run pnpm pub to publish it to the src/content/posts directory when finished.

5. Refer to the official guide to deploy your blog to Vercel, Netlify, GitHub Pages, etc. Before deployment, edit the site settings in astro.config.mjs.

Article Front Matter

---
title: Article Title
slug: post-entry # The article will be generated at the path [BASE_URL]/posts/post-entry/
published: 1970-01-01T00:00:00Z
description: Article Description
category: Lorem
tags: [Foo, Bar]
cover: /path/to/cover.jpg
lang: en # Only needed when article language differs from site language in `config.ts`
comment: true # Enable comments, requires comment system to be enabled and configured in `config.ts`
---

Commands

All commands need to be run from the project root directory:

Command	Action
pnpm install	Install dependencies
pnpm dev	Start dev server at localhost:4321
pnpm build	Build static site to ./dist/
pnpm preview	Preview built site locally
pnpm new [draft|post] [title]	Create new article
pnpm pub	Publish draft
pnpm lint	Check code
pnpm format	Format code
pnpm astro ...	Run Astro CLI

Acknowledgments

• This project is inspired by Fuwari and references some of its code and design elements.
• This project is inspired by Pure and references some of its code and design elements.
• This project is inspired by Solitude and references some of its design elements.