From 157c171d97b96a8fc019d58aefe76da8dc750410 Mon Sep 17 00:00:00 2001 From: radishzzz Date: Fri, 16 May 2025 22:57:37 +0100 Subject: [PATCH] docs: update readme --- README.md | 19 +++++-------------- README.zh.md | 19 +++++-------------- 2 files changed, 10 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 485099a..cea0c2d 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,6 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram ## Performance
-

Retypeset Lighthouse Score @@ -52,15 +51,13 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram ## Getting Started 1. [Fork](https://github.com/radishzzz/astro-theme-retypeset/fork) this repository, or use this template to create a new repository. - -2. Click the `Code` button, copy the `HTTPS` URL, and run the following commands in your terminal: - +2. Run the following commands in your terminal: ```bash # Clone the repository - git clone repository-url + git clone # Navigate to the project directory - cd repository-name + cd # Install pnpm globally (if not already installed) npm install -g pnpm @@ -71,12 +68,8 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram # Start the development server pnpm dev ``` - -3. Open [localhost:4321](http://localhost:4321/) in your browser to see a live preview of your website. - -4. Refer to the [Theme Guide](https://retypeset.radishzz.cc/en/posts/theme-guide/) to customize your blog and create new articles. - -5. Refer to the [Astro Deployment Guides](https://docs.astro.build/en/guides/deploy/) to deploy your blog to Netlify, Vercel, or other platforms. +3. Refer to the [Theme Guide](https://retypeset.radishzz.cc/en/posts/theme-guide/) to customize your blog and create new articles. +4. Refer to the [Astro Deployment Guides](https://docs.astro.build/en/guides/deploy/) to deploy your blog to Netlify, Vercel, or other platforms.  [![Deploy to Netlify](images/deploy-netlify.svg)](https://app.netlify.com/start) [![Deploy to Vercel](images/deploy-vercel.svg)](https://vercel.com/new) @@ -84,9 +77,7 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram ## Updates - Retypeset releases [new features](https://github.com/radishzzz/astro-theme-retypeset/issues/18) from time to time, which can be updated as follows. - - Refer to the [GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) to run `Sync fork` in your repository to sync with the latest branch. - - Do not click `Discard Changes`, or you will lose your modifications. ## Credits diff --git a/README.zh.md b/README.zh.md index 8517578..1aa38d3 100644 --- a/README.zh.md +++ b/README.zh.md @@ -42,7 +42,6 @@ Retypeset 是一款基于 [Astro](https://astro.build/) 框架的静态博客主 ## 性能
-

Retypeset Lighthouse Score @@ -52,15 +51,13 @@ Retypeset 是一款基于 [Astro](https://astro.build/) 框架的静态博客主 ## 开始 1. [Fork](https://github.com/radishzzz/astro-theme-retypeset/fork) 此仓库，或使用此模版创建新仓库。 - -2. 点击 `Code` 按钮，复制 `HTTPS` 地址，在终端执行： - +2. 在终端执行： ```bash # 克隆仓库 - git clone 仓库地址 + git clone <仓库地址> # 进入项目目录 - cd 仓库名称 + cd <仓库名称> # 全局安装 pnpm（如果未安装） npm install -g pnpm @@ -71,12 +68,8 @@ Retypeset 是一款基于 [Astro](https://astro.build/) 框架的静态博客主 # 启动开发服务器 pnpm dev ``` - -3. 在浏览器中打开 [localhost:4321](http://localhost:4321/)，查看网站的实时预览。 - -4. 参考 [主题上手指南](https://retypeset.radishzz.cc/posts/theme-guide/)，自定义你的博客并创建新文章。 - -5. 参考 [Astro 部署指南](https://docs.astro.build/zh-cn/guides/deploy/)，将博客部署至 Netlify、Vercel 等平台。 +3. 参考 [主题上手指南](https://retypeset.radishzz.cc/posts/theme-guide/)，自定义你的博客并创建新文章。 +4. 参考 [Astro 部署指南](https://docs.astro.build/zh-cn/guides/deploy/)，将博客部署至 Netlify、Vercel 等平台。  [![Deploy to Netlify](images/deploy-netlify.svg)](https://app.netlify.com/start) [![Deploy to Vercel](images/deploy-vercel.svg)](https://vercel.com/new) @@ -84,9 +77,7 @@ Retypeset 是一款基于 [Astro](https://astro.build/) 框架的静态博客主 ## 更新 - Retypeset 会不定期发布 [新功能](https://github.com/radishzzz/astro-theme-retypeset/issues/18)，更新方法如下。 - - 参考 [GitHub 文档](https://docs.github.com/zh/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork)，在仓库中执行 `Sync fork` 同步最新分支。 - - 不要点击 `Discard Changes`，否则会丢失你的更改。 ## 鸣谢