Star Read Astro博客主题

🏴󠁧󠁢󠁥󠁮󠁧󠁿 English Document | 🇨🇳 中文文档 | 🇯🇵 日本語ドキュメント | 🇰🇷 한국어 문서 | 🇷🇺 Русская документация

既有星光般的璀璨，又不失简洁和高端感的Astro主题

🚀 特性

🎨 现代化UI设计
🔍 支持本地搜索和Algolia搜索
📱 响应式设计
🌙 深色/浅色主题切换
🏷️ 标签和分类支持
📊 文章统计和作者信息展示

📦 安装

方法一：通过CLI工具初始化

包管理器	建议命令
pnpm / pnpx	`pnpm dlx astro-theme-starread init` 或 `pnpx astro-theme-starread init`
npm (npx)	`npx astro-theme-starread init`
Yarn	`yarn dlx astro-theme-starread init`（需 Yarn v2+）

我们提供了create命令，方便用户在指定文件夹创建主题

创建项目：根据您使用的包管理器，选择以下命令之一：

# 使用 pnpm
pnpm create astro-theme-starread my-blog

# 使用 npm
npx create-astro-theme-starread my-blog

# 使用 yarn
yarn create astro-theme-starread my-blog

# 使用 cnpm
cnpm init astro-theme-starread my-blog

cd my-blog

安装依赖：

pnpm install

启动开发服务器：

pnpm dev

方法二：使用`astro`模版安装

WARNING

该方式需访问Github仓库，确保网络畅通。

包管理器	命令
pnpm	`pnpm create astro@latest --template passwordgloo/astro-theme-starread`
npm	`npm create astro@latest -- --template passwordgloo/astro-theme-starread`
yarn	`yarn create astro --template passwordgloo/astro-theme-starread`

方法三：源码安装

WARNING

该方式需访问Github仓库，确保网络畅通。

git clone https://github.com/passwordgloo/astro-theme-starread
cd astro-theme-starread
pnpm install

NOTE

安装完成后，运行开发服务器：

pnpm dev

方法四：作为依赖安装到现有 Astro 项目

您可以将主题作为依赖安装到现有的 Astro 项目中，并直接从 node_modules 使用其组件、布局和页面。

安装主题包：

# 使用 pnpm
pnpm add astro-theme-starread

# 使用 npm
npm install astro-theme-starread

# 使用 yarn
yarn add astro-theme-starread

直接从 node_modules 导入并使用组件：

---
// 直接从 node_modules 中的主题导入组件
import { NavBar, ThemeToggle, ArticleInfo, AuthorWidget, TagCloud } from 'astro-theme-starread';
---

<html>
  <head>
    <title>我的 Astro 博客</title>
    <!-- 如需使用主题样式 -->
    <link rel="stylesheet" href="node_modules/astro-theme-starread/src/styles/global.css" />
  </head>
  <body>
    <!-- 使用 node_modules 中的 NavBar 组件 -->
    <NavBar />
    
    <!-- 使用 node_modules 中的 ThemeToggle 组件 -->
    <ThemeToggle />
    
    <article>
      <!-- 使用带属性的 ArticleInfo 组件 -->
      <ArticleInfo 
        title="我的文章"
        date="2024-01-01"
        author="作者名称"
      />
      <p>文章内容...</p>
    </article>
    
    <aside>
      <!-- 使用侧边栏组件 -->
      <AuthorWidget />
      <TagCloud />
    </aside>
  </body>
</html>

直接从 node_modules 使用布局：

---
// 直接从 node_modules 中的主题导入布局
import { article as ArticleLayout } from 'astro-theme-starread';

// 应用来自 node_modules 的布局
export const layout = ArticleLayout;

// 您的内容
export const content = {
  title: "我的博客文章",
  date: "2024-01-01",
  author: "作者名称",
  tags: ["技术", "博客"]
};
---

<!-- 此内容将在 node_modules 的布局中渲染 -->
<main>
  <p>这是我博客文章的内容。它将在主题的文章布局中渲染。</p>
</main>

📂 项目结构

/
├── src/
│   ├── components/     # 组件文件
│   ├── content/        # 内容配置
│   ├── layouts/        # 布局模板
│   ├── pages/          # 页面路由
│   └── styles/         # 样式文件
├── public/             # 静态资源
└── dist/               # 构建输出

🔍 搜索

本地搜索

默认使用本地搜索，首次使用请运行pnpm local 建立本地索引

Algolia搜索

IMPORTANT

生产环境中建议使用环境变量方式配置，避免敏感信息暴露在代码中。

编辑starread.config.ts 选择Algolia搜索

export const themeConfig: starreadthemeconfig = {
  search: {
    // 搜索服务提供商: 'local', 'algolia'
      provider: 'algolia',
    }
}

NOTE

Algolia搜索需要您的Algolia应用ID、搜索密钥、索引名称和管理员API密钥。

TIP

如果您没有Algolia账号，需要先注册并创建一个应用。

PUBLIC_ALGOLIA_APP_ID=您的Algolia应用ID
PUBLIC_ALGOLIA_SEARCH_KEY=您的Algolia搜索密钥
PUBLIC_ALGOLIA_INDEX_NAME=您的索引名称
ALGOLIA_WRITE_API_KEY=您的写入API密钥（用于索引上传）

推送索引到Algolia

运行pnpm algolia 推送本地索引到Algolia

⚙️ 自定义配置

您可以通过修改根目录下的 starread.config.ts 文件来自定义主题配置，包括网站标题、导航菜单、作者信息、侧边栏组件显示等。

示例配置项：

// 修改网站标题
site: {
  title: '我的博客',
  // ...其他配置
}

// 自定义导航菜单
nav: [
  { name: '首页', href: '/' },
  { name: '关于', href: '/about' },
  // ...其他菜单项
]

🔧 Twikoo 评论

TIP

如需启用twikoo，请修改src/compponents/Comment.astros中的第13行envId为您的twikoo环境地址。

<script>
  document.addEventListener('DOMContentLoaded', function() {
    if (window.twikoo) {
      window.twikoo.init({
        envId: 'https://example.com',// 你的环境地址
        el: '#tcomment',
        path: window.location.pathname
      });
    } else {
      console.error('Twikoo 加载失败，请检查 twikoo本地位置或者CDN地址');
    }
  });
</script>

🧞 命令

命令	描述
`pnpm install`	安装依赖
`pnpm dev`	启动本地开发服务器 `localhost:4321`
`pnpm preview`	本地预览构建结果
`pnpm local`	运行自动索引脚本并构建生产站点
`pnpm algolia`	推送数据到Algolia搜索
`pnpm changelog`	生成更新日志
`pnpm release`	版本管理（更新版本号、生成提交等）

搜索文档

未找到结果

菜单