mirror of
https://github.com/reonokiy/blog.nokiy.net.git
synced 2025-06-15 11:12:54 +02:00
docs: update readme
This commit is contained in:
radishzzz
parent
21d502b8d0
commit
49793d5d55
3 changed files with 27 additions and 23 deletions
16
README.md
16
README.md
|
|
@ -41,6 +41,8 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram
|
|||
|
||||
## Performance
|
||||
|
||||
<br>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://pagespeed.web.dev/analysis?url=https%3A%2F%2Fretypeset.radishzz.cc%2F">
|
||||
<img width="710" alt="Retypeset Lighthouse Score" src="assets/retypeset-lighthouse-score.svg">
|
||||
|
|
@ -55,10 +57,10 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram
|
|||
|
||||
```bash
|
||||
# Clone the remote repository to your local machine
|
||||
git clone <repository-url>
|
||||
git clone repository-url
|
||||
|
||||
# Navigate to the repository directory
|
||||
cd <repository-name>
|
||||
cd repository-name
|
||||
|
||||
# Install pnpm globally (if not already installed)
|
||||
npm install -g pnpm
|
||||
|
|
@ -86,16 +88,16 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram
|
|||
|
||||
1. Click `Deploy to Netlify` or `Deploy to Vercel` below.
|
||||
|
||||
[](https://app.netlify.com/start)
|
||||
[](https://vercel.com/new)
|
||||
 [](https://app.netlify.com/start)
|
||||
[](https://vercel.com/new)
|
||||
|
||||
1. Follow the instructions, select your repository, and click `Deploy` to start deployment.
|
||||
2. Follow the instructions, select your repository, and click `Deploy` to start deployment.
|
||||
|
||||
2. For other platforms, please refer to the [Astro Deployment Guides](https://docs.astro.build/en/guides/deploy/).
|
||||
3. For other platforms, please refer to the [Astro Deployment Guides](https://docs.astro.build/en/guides/deploy/).
|
||||
|
||||
## Updates
|
||||
|
||||
Retypeset releases new features and bug fixes from time to time. You can 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 forked repository to synchronize with the latest branch. Be careful not to click `Discard Changes`, or you will lose your modifications.
|
||||
Theme Retypeset releases new features and bug fixes from time to time. You can 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 forked repository to synchronize with the latest branch. Be careful not to click `Discard Changes`, or you will lose your modifications.
|
||||
|
||||
## Commands
|
||||
|
||||
|
|
|
|||
18
README.zh.md
18
README.zh.md
|
|
@ -41,6 +41,8 @@ Retypeset 是一款基于 [Astro](https://astro.build/) 框架的静态博客主
|
|||
|
||||
## 性能
|
||||
|
||||
<br>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://pagespeed.web.dev/analysis?url=https%3A%2F%2Fretypeset.radishzz.cc%2F">
|
||||
<img width="710" alt="Retypeset Lighthouse Score" src="assets/retypeset-lighthouse-score.svg">
|
||||
|
|
@ -55,10 +57,10 @@ Retypeset 是一款基于 [Astro](https://astro.build/) 框架的静态博客主
|
|||
|
||||
```bash
|
||||
# 克隆远程仓库至本地
|
||||
git clone <仓库地址>
|
||||
git clone 仓库地址
|
||||
|
||||
# 进入本地仓库根目录
|
||||
cd <仓库名称>
|
||||
cd 仓库名称
|
||||
|
||||
# 全局安装 pnpm（若未安装）
|
||||
npm install -g pnpm
|
||||
|
|
@ -86,16 +88,16 @@ Retypeset 是一款基于 [Astro](https://astro.build/) 框架的静态博客主
|
|||
|
||||
1. 点击下方 `Deploy to Netlify` 或 `Deploy to Vercel`。
|
||||
|
||||
[](https://app.netlify.com/start)
|
||||
[](https://vercel.com/new)
|
||||
 [](https://app.netlify.com/start)
|
||||
[](https://vercel.com/new)
|
||||
|
||||
1. 跟随指示，选择对应仓库，再点击 `Deploy` 即可开始部署。
|
||||
2. 跟随指示，选择对应仓库，再点击 `Deploy` 即可开始部署。
|
||||
|
||||
2. 其它平台请参考 [Astro 部署指南](https://docs.astro.build/zh-cn/guides/deploy/)。
|
||||
3. 其它平台请参考 [Astro 部署指南](https://docs.astro.build/zh-cn/guides/deploy/)。
|
||||
|
||||
## 更新
|
||||
|
||||
Retypeset 会不定期发布新功能和问题修复。你可以参考 [GitHub 文档](https://docs.github.com/zh/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork)，在复刻仓库中执行 `Sync fork` 同步最新分支。注意不要点击 `Discard Changes`，否则会丢失你的更改。
|
||||
Retypeset 主题会不定期发布新功能和问题修复。你可以参考 [GitHub 文档](https://docs.github.com/zh/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork)，在复刻仓库中执行 `Sync fork` 同步最新分支。注意，不要点击 `Discard Changes`，否则会丢失你的更改。
|
||||
|
||||
## 指令
|
||||
|
||||
|
|
@ -121,7 +123,7 @@ Retypeset 会不定期发布新功能和问题修复。你可以参考 [GitHub
|
|||
|
||||
## Star History
|
||||
|
||||
谢谢每一位 star 的朋友，你们的支持是我持续维护项目的动力！
|
||||
感谢每一位 star 的朋友，你们的支持是我持续维护项目的动力！
|
||||
|
||||
<p align="center">
|
||||
<a href="https://star-history.com/#radishzzz/astro-theme-retypeset&Date">
|
||||
|
|
|
|||
16
pnpm-lock.yaml
generated
16
pnpm-lock.yaml
generated
|
|
@ -2934,11 +2934,11 @@ packages:
|
|||
resolution: {integrity: sha512-VXJjc87FScF88uafS3JllDgvAm+c/Slfz06lorj2uAY34rlUu0Nt+v8wreiImcrgAjjIHp1rXpTDlLOGw29WwQ==}
|
||||
engines: {node: '>=18'}
|
||||
|
||||
oniguruma-parser@0.5.4:
|
||||
resolution: {integrity: sha512-yNxcQ8sKvURiTwP0mV6bLQCYE7NKfKRRWunhbZnXgxSmB1OXa1lHrN3o4DZd+0Si0kU5blidK7BcROO8qv5TZA==}
|
||||
oniguruma-parser@0.11.0:
|
||||
resolution: {integrity: sha512-9M+tFRnJWtRxsgh4XFlkw+AVFtzEtI8UfTifx6sDbtt47SpEl/K65PunQyp/jvfp0xwLGjtbE5aKQcL8j6AXYw==}
|
||||
|
||||
oniguruma-to-es@4.1.0:
|
||||
resolution: {integrity: sha512-SNwG909cSLo4vPyyPbU/VJkEc9WOXqu2ycBlfd1UCXLqk1IijcQktSBb2yRQ2UFPsDhpkaf+C1dtT3PkLK/yWA==}
|
||||
oniguruma-to-es@4.2.0:
|
||||
resolution: {integrity: sha512-MDPs6KSOLS0tKQ7joqg44dRIRZUyotfTy0r+7oEEs6VwWWP0+E2PPDYWMFN0aqOjRyWHBYq7RfKw9GQk2S2z5g==}
|
||||
|
||||
optionator@0.9.4:
|
||||
resolution: {integrity: sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==}
|
||||
|
|
@ -4803,7 +4803,7 @@ snapshots:
|
|||
dependencies:
|
||||
'@shikijs/types': 3.2.2
|
||||
'@shikijs/vscode-textmate': 10.0.2
|
||||
oniguruma-to-es: 4.1.0
|
||||
oniguruma-to-es: 4.2.0
|
||||
|
||||
'@shikijs/engine-oniguruma@3.2.2':
|
||||
dependencies:
|
||||
|
|
@ -7500,12 +7500,12 @@ snapshots:
|
|||
dependencies:
|
||||
mimic-function: 5.0.1
|
||||
|
||||
oniguruma-parser@0.5.4: {}
|
||||
oniguruma-parser@0.11.0: {}
|
||||
|
||||
oniguruma-to-es@4.1.0:
|
||||
oniguruma-to-es@4.2.0:
|
||||
dependencies:
|
||||
emoji-regex-xs: 1.0.0
|
||||
oniguruma-parser: 0.5.4
|
||||
oniguruma-parser: 0.11.0
|
||||
regex: 6.0.1
|
||||
regex-recursion: 6.0.2
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue