HPCesia/AstralHalo
1
0
Fork 0
mirror of https://codeberg.org/HPCesia/AstralHalo.git synced 2025-04-08 17:34:27 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
A blog template powered by Astro
78 Commits 1 Branch 2 Tags 4.3 MiB
Astro 51.4%
TypeScript 30.9%
JavaScript 10.1%
CSS 3.5%
MDX 3.2%
Other 0.9%
bf458d1ef8
Go to file
HPCesia bf458d1ef8 chore: bump version to 0.1.0
2025-02-02 21:05:40 +08:00
.vscode feat: page-switch & aside 2025-01-21 17:08:16 +08:00
scaffolds feat: add useful scripts 2025-02-01 18:01:24 +08:00
scripts feat: add useful scripts 2025-02-01 18:01:24 +08:00
src feat: twikoo OwO style 2025-02-02 19:59:57 +08:00
.gitignore init: first demo 2025-01-12 03:54:02 +08:00
.prettierignore init: first demo 2025-01-12 03:54:02 +08:00
.prettierrc.cjs style: prettier format 2025-01-23 13:34:59 +08:00
.stylelintignore style: prettier format 2025-01-23 13:34:59 +08:00
astro.config.mjs feat: implement pagefind search 2025-02-01 15:38:08 +08:00
eslint.config.js style: prettier format 2025-01-23 13:34:59 +08:00
LICENSE doc: Create LICENSE 2025-02-01 19:21:29 +08:00
package.json chore: bump version to 0.1.0 2025-02-02 21:05:40 +08:00
postcss.config.mjs style: prettier format 2025-01-23 13:34:59 +08:00
README-zh_CN.md docs: update README 2025-02-02 21:03:22 +08:00
README.md docs: update README 2025-02-02 21:03:22 +08:00
stylelint.config.mjs refactor: darkmode 2025-01-18 16:05:01 +08:00
tailwind.config.mjs feat: support dark mode 2025-01-17 21:52:21 +08:00
tsconfig.json feat: page-switch & aside 2025-01-21 17:08:16 +08:00

README.md

Astral Halo

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

Astral Halo is a static blog template developed with Astro.

Features

  • Built with Astro and Tailwind CSS
  • Freely switchable light/dark themes
  • Responsive design
  • Search functionality (currently only supports Pagefind)
  • Article table of contents
  • Comments system (currently only supports Twikoo)
  • Smooth animations and page transitions

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 [title] 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
published: 1970-01-01T00:00:00.000Z
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 [title] Publish draft
pnpm lint Check code
pnpm format Format code
pnpm astro ... Run Astro CLI

Acknowledgments

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