blog/README.zh.md
radishzzz 21d502b8d0 docs: update detailed usage documentation in readme
- update footnotes style
- update theme guides
2025-04-13 23:33:30 +01:00

5.3 KiB
Raw Blame History

Cover Image Cover Image

重新编排

Retypeset 是一款基于 Astro 框架的静态博客主题,中文名为重新编排。本主题以 活版印字 为设计灵感,通过建立全新的视觉规范,对所有页面进行重新编排,打造纸质书页般的阅读体验,再现版式之美。所见皆为细节,方寸尽显优雅。

预览

特征

  • 基于 Astro 与 UnoCSS 开发
  • 支持 SEO、Sitemap、OpenGraph、TOC、RSS、MDX 和 KaTeX
  • i18n 多语言
  • 亮色/暗色模式
  • 优雅的过渡动画
  • 丰富的主题配置
  • 中文排版优化
  • 响应式设计
  • 评论系统

性能

Retypeset Lighthouse Score

用法

  1. 点击 Fork 复刻此仓库,或使用此模版创建新仓库。

  2. 在复刻仓库中点击 Code 按钮,复制 HTTPS 仓库地址,并在终端中执行:

    # 克隆远程仓库至本地
    git clone <仓库地址>
    
    # 进入本地仓库根目录
    cd <仓库名称>
    
    # 全局安装 pnpm若未安装
    npm install -g pnpm
    
    # 安装项目依赖
    pnpm install
    
    # 启动本地开发服务器
    pnpm dev
    
  3. 在浏览器中打开 http://localhost:4321/,即可实时预览主题效果。

  4. 修改主题配置文件 src/config.ts 来自定义你的博客。

  5. 提交并推送你的修改至远程仓库。

文档

部署

  1. 点击下方 Deploy to NetlifyDeploy to Vercel

Deploy to Netlify Deploy to Vercel

  1. 跟随指示,选择对应仓库,再点击 Deploy 即可开始部署。

  2. 其它平台请参考 Astro 部署指南

更新

Retypeset 会不定期发布新功能和问题修复。你可以参考 GitHub 文档,在复刻仓库中执行 Sync fork 同步最新分支。注意不要点击 Discard Changes,否则会丢失你的更改。

指令

以下指令均需要在项目根目录执行:

指令 作用
pnpm install 安装项目依赖
pnpm dev localhost:4321 启动本地开发服务器
pnpm build 构建网站至 ./dist/
pnpm preview 本地预览已构建的网站
pnpm astro ... 执行 astro add, astro check 等命令
pnpm astro -- --help 获取 Astro CLI 帮助信息

鸣谢

Star History

谢谢每一位 star 的朋友,你们的支持是我持续维护项目的动力!

Star History Chart