Skip to content

Latest commit

 

History

History
205 lines (147 loc) · 6 KB

README.zh-CN.md

File metadata and controls

205 lines (147 loc) · 6 KB
Raw

活版印字

Typography

在线预览
此主题系 Hexo 主题 活版印字 在 Astro 平台上的移植版本

English |简体中文

特性

  • 使用 Astro、TypeScript 和 UnoCSS 构建。
  • 快速:100% Pagespeed Score。
  • 排版: 根据流行的中文排版规范派生出的排版，旨在为网站访客提供更佳的阅读体验。
  • 响应式: 响应式设计，适用于所有屏幕尺寸。
  • 易访问: 深思熟虑的语义和易访问内容。
  • SEO 友好: 支持 Open Graph 和 Twitter Cards，提供更好的社交分享体验。
  • 为搜索引擎提供 站点地图 和 RSS 订阅。
  • 支持 i18n 国际化。
  • 支持 Disqus、Giscus、Twikoo 作为评论服务。
  • 支持暗色模式。

Demo

提交一个 PR 来添加你的博客 Demo。

开始使用

这是一个轻巧、响应式设计且对 SEO 友好的 Astro 博客主题。本指南将帮助您开始一个新项目。

快速开始

您可以通过点击右上角的 Fork 按钮，将仓库克隆到你的账号下，点击下面的按钮，选择你刚刚 Fork 的仓库，点击 Import 按钮，即可进入到项目配置页面。

Deploy with Vercel Deploy to Netlify

或者你也可以参考Astro的文档，部署到你喜欢的平台。

添加文章

您可以通过在 src/content/posts中创建一个新的文件来添加内容。该文件需要前面的元数据，如下所示：

---
title: title
pubDate: 2021-08-01
categories: ['article']
description: 'description'
---

或者，您可以在终端中使用以下命令创建新帖子：

pnpm new-post

更新主题

您只需在自己 Fork 的项目上 Sync Fork 即可（不要点击 Discard Changes，否则会丢失你自己的更改）。

定制化

「活版印字」主题是高度可定制的。默认配置文件为 src/.config/default.ts，您可以根据需要在 src/.config/user.ts 中覆盖默认配置。

社交链接

「活版印字」主题内置支持通过配置文件中的社交选项将指向您的社交媒体帐户的链接添加到网站：

socials: [
  {
    name: 'github',
    href: 'https://github.com/moeyua/astro-theme-typography'
  }
]

字段 name 是 Material Design Icons 中的图标名称，将自动生成为图标。

请注意，您需要重新启动开发服务器才能看到更改。

导航链接

默认情况下，导航是「文章」、「归档」、「分类」和「关于」。您可以在配置文件中添加更多内容：

navs: [
  {
    name: 'Categories',
    href: '/categories'
  }
]

然后在src/page中添加相应的页面，在 Astro Pages中查看更多

黑暗模式

「活版印字」主题支持深色模式。您可以在配置文件中更改它：

themeStyle: 'dart' // 'light' | 'dark'

国际化 (i18n)

「活版印字」主题为多语言站点提供内置支持。默认情况下，语言为'en-us'，您可以在配置文件中更改它：

locale: 'zh-cn'

目前，「活版印字」主题支持以下语言：

  • en-us
  • zh-cn
  • zh-tw
  • ja-jp

您可以在src/i18n.ts中查看所有支持的语言，并根据需要添加更多。

评论

「活版印字」主题支持多种评论服务，目前支持 Disqus、Giscus 和 Twikoo。

通过添加配置文件来启用对应的评论服务，填写多个评论服务时，只会按照顺序显示第一个服务。

Disqus

在配置文件中添加您的 Disqus Shortname：

{
  comments: {
    disqus: {
      shortname: 'your-disqus-shortname'
    }
  }
}

Giscus

基于 Giscus web component 实现。

属性名称与 giscus 网站 上显示的 data- 属性相同，但以小写形式编写，并删除了 data- 前缀并删除了破折号。

在配置文件中添加您的 Giscus 配置：

{
  comments: {
    giscus: {
      repo: 'moeyua/astro-theme-typography'
      repoId: 'R_kgDOKy9HOQ'
      category: 'General'
      categoryId: 'DIC_kwDOKy9HOc4CegmW'
      mapping: 'title'
      strict: '0'
      reactionsEnabled: '1'
      emitMetadata: '1'
      inputPosition: 'top'
      theme: 'light'
      lang: 'zh-CN'
      loading: 'lazy'
    }
  }
}

Twikoo

在配置文件中添加您的 Twikoo 配置：

comments: {
  twikoo: {
    envId: 'your-env-id'
  }
}

Pagespeed 分数

Pagespeed Score

TODO

  • WebSub
  • comment
  • search
  • analytics