astro-theme-stalux
v1.0.0
Published
Stalux - 一款高效、美观、灵活的 Astro 博客主题
Maintainers
Readme
🌟 Stalux - 高效、美观、灵活的 Astro 博客主题
Stalux 是一款基于 Astro 框架开发的静态博客主题,专为内容创作者设计,追求高性能、美观直观的用户界面与灵活的配置系统。主题名称"Stalux"中的"Sta"代表静态(Static),"lux"代表奢华(Luxury)的外观体验。
📦 主题结构
Stalux 主题采用清晰的项目结构,便于管理和定制:
├── public/ # 静态资源 (图片、字体等)
├── src/
│ ├── _config.ts # 自定义配置文件
│ ├── components/ # UI组件
│ ├── content/ # 内容集合 (博客文章、关于页面)
│ │ ├── posts/ # 博客文章
│ │ └── about/ # 关于页面
│ ├── consts.ts # 默认配置常量
│ ├── layouts/ # 页面布局组件
│ ├── pages/ # 页面定义
│ ├── styles/ # 全局样式
│ ├── types.ts # TypeScript类型定义
│ └── utils/ # 工具函数
├── astro.config.mjs # Astro 配置
└── tsconfig.json # TypeScript 配置简单,但不简陋;美观,但不浮华。
Stalux 是一款基于 Astro 框架开发的静态博客主题,专为内容创作者设计,追求高性能、美观直观的用户界面与灵活的配置系统。主题名称"Stalux"中的"Sta"代表静态(Static),"lux"代表奢华(Luxury)的外观体验
~~其实是我瞎编的~~
✨ 特性
- 🚀 极致性能 - 基于 Astro 构建,100/100 Lighthouse 性能评分
- 🎨 美观直观 - 精心设计的界面,提供清晰的阅读体验
- ⚙️ 灵活配置 - 丰富的自定义选项,通过
_config.ts轻松配置 - 📱 响应式设计 - 在各种设备上提供出色体验
- 🌓 暗色模式 - 内置浅色/深色主题切换功能
- 💬 评论系统 - 集成 Waline 评论系统,轻量且功能丰富
- 🔍 SEO优化 - 内置多种SEO优化技术,提高搜索引擎可见性
- 📰 RSS 支持 - 自动生成 RSS 订阅源
- 🗺️ 站点地图 - 自动生成站点地图,提升 SEO
- 📝 Markdown & MDX - 支持丰富的 Markdown 和 MDX 内容创作
🚀 开始使用
安装依赖
用其他包管理器也可以,比如说yarn,pnpm,bun...
npm install开发服务器
npm dev启动后访问 http://localhost:4321 查看您的站点。
构建项目
npm build生成的静态文件将位于 ./dist/ 目录。
预览构建结果
npm preview📝 内容创作
Stalux 支持通过 Markdown 和 MDX 创建内容,文件放置在 src/content/ 目录下:
- 博客文章: 在
src/content/posts/中创建.md或.mdx文件 - 关于页面: 在
src/content/about/中创建.md或.mdx文件
Frontmatter 配置
每个 Markdown 文件需要在顶部添加 frontmatter 配置:
---
title: 文章标题
tags:
- 标签1
- 标签2
categories:
- 分类
date: 2025-5-10T10:00:00+08:00
---
文章内容...⚙️ 主题配置
Stalux 提供了灵活的配置系统,通过修改 src/_config.ts 文件进行自定义:
- 将
useConfig设置为true以启用自定义配置 - 修改
siteConfig对象中的各项配置
// src/_config.ts
export const useConfig: boolean = true;
export const siteConfig: SiteConfig = {
// 站点基本信息
title: '我的博客',
siteName: '我的博客',
author: '作者名',
description: '博客描述...',
// 其他配置...
}详细配置项可参考主题文档中的配置指南。
🌐 部署
Stalux 主题生成的是纯静态网站,可以轻松部署到:
- Vercel
- Netlify
- GitHub Pages
- 任何支持静态网站的托管服务
🧞 常用命令
所有命令在项目根目录下运行:
| 命令 | 功能 |
| :----------------------- | :----------------------------------------------- |
| npm install | 安装依赖 |
| npm dev | 启动本地开发服务器,地址为 localhost:4321 |
| npm build | 构建生产站点到 ./dist/ 目录 |
| npm preview | 在部署前本地预览构建结果 |
| npm astro ... | 运行CLI命令,如 astro add, astro check |
🙏 致谢
Stalux 主题基于 Astro 框架开发,同时受到多个优秀开源项目的启发。特别感谢:
📄 许可证
Stalux 主题基于 MIT 许可证开源,您可以自由地使用、修改和分发。
开始使用 Stalux 创建您的博客,展示您的创意与知识吧!如有问题或建议,欢迎通过 GitHub 提交 Issue 或 Pull Request。
