mirror of
https://github.com/reonokiy/blog.nokiy.net.git
synced 2025-06-14 18:56:46 +02:00
docs: update readme and theme guide
This commit is contained in:
radishzzz
parent
2d28bf93a5
commit
e8c2ac5790
8 changed files with 100 additions and 38 deletions
|
|
@ -69,6 +69,7 @@ Retypeset is a static blog theme based on the [Astro](https://astro.build/) fram
|
|||
# Start the development server
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -76,7 +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. You can refer to the [GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) and run `Sync fork` in your repository to sync with the latest branch. Do not click `Discard Changes`, or you will lose your modifications.
|
||||
Retypeset releases [new features](https://github.com/radishzzz/astro-theme-retypeset/issues/18) from time to time. Simply run `pnpm update-theme` to update the theme. If you encounter merge conflicts, please refer to [this video](https://youtu.be/lz5OuKzvadQ?si=sH_ALNgqxrYqNVQT) for manual resolution.
|
||||
|
||||
## Credits
|
||||
|
||||
|
|
|
|||
|
|
@ -69,6 +69,7 @@ Retypeset 是一款基于 [Astro](https://astro.build/) 框架的静态博客主
|
|||
# 启动开发服务器
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
3. 参考 [主题上手指南](https://retypeset.radishzz.cc/posts/theme-guide/)，自定义你的博客并创建新文章。
|
||||
4. 参考 [Astro 部署指南](https://docs.astro.build/zh-cn/guides/deploy/)，将博客部署至 Netlify、Vercel 等平台。
|
||||
|
||||
|
|
@ -76,7 +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`，否则会丢失你的更改。
|
||||
Retypeset 会不定期发布 [新功能](https://github.com/radishzzz/astro-theme-retypeset/issues/18)，执行 `pnpm update-theme` 即可更新主题。如果遇到合并冲突，请参考 [此视频](https://youtu.be/lz5OuKzvadQ?si=sH_ALNgqxrYqNVQT) 手动解决。
|
||||
|
||||
## 鸣谢
|
||||
|
||||
|
|
|
|||
|
|
@ -52,8 +52,18 @@ To create admonition blocks, use the GitHub syntax `> [!TYPE]` or the triple col
|
|||
> [!NOTE]
|
||||
> Useful information that users should know, even when skimming content.
|
||||
|
||||
:::note
|
||||
Useful information that users should know, even when skimming content.
|
||||
> [!TIP]
|
||||
> Helpful advice for doing things better or more easily.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Key information users need to know to achieve their goal.
|
||||
|
||||
:::warning
|
||||
Urgent info that needs immediate user attention to avoid problems.
|
||||
:::
|
||||
|
||||
:::caution
|
||||
Advises about risks or negative outcomes of certain actions.
|
||||
:::
|
||||
|
||||
:::note[YOUR CUSTOM TITLE]
|
||||
|
|
|
|||
|
|
@ -52,8 +52,18 @@ Para crear bloques de advertencia, utilice la sintaxis de GitHub `> [!TYPE]` o l
|
|||
> [!NOTE]
|
||||
> Información útil que los usuarios deben conocer, incluso al leer por encima.
|
||||
|
||||
:::note
|
||||
Información útil que los usuarios deben conocer, incluso al leer por encima.
|
||||
> [!TIP]
|
||||
> Consejos útiles para hacer las cosas mejor o más fácilmente.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Información clave que los usuarios necesitan saber para lograr su objetivo.
|
||||
|
||||
:::warning
|
||||
Información urgente que requiere atención inmediata del usuario para evitar problemas.
|
||||
:::
|
||||
|
||||
:::caution
|
||||
Advierte sobre riesgos o resultados negativos de ciertas acciones.
|
||||
:::
|
||||
|
||||
:::note[TÍTULO PERSONALIZADO]
|
||||
|
|
|
|||
|
|
@ -50,38 +50,48 @@ GitHub構文 `> [!TYPE]` または三重コロン構文 `:::type` を使用し
|
|||
|
||||
```
|
||||
> [!NOTE]
|
||||
> 基本的な情報内容。
|
||||
> 内容を流し読みする場合でも、ユーザーに知ってほしい有益な情報。
|
||||
|
||||
:::note
|
||||
基本的な情報内容。
|
||||
> [!TIP]
|
||||
> タスクをよりスムーズに完了するために役立つオプション情報。
|
||||
|
||||
> [!IMPORTANT]
|
||||
> タスクを完了するためにユーザーが必要とする重要な情報。
|
||||
|
||||
:::warning
|
||||
ユーザーの即時の注意を必要とする潜在的なリスクがある重要な内容。
|
||||
:::
|
||||
|
||||
:::caution
|
||||
特定の操作によって生じる可能性のある悪影響について。
|
||||
:::
|
||||
|
||||
:::note[カスタムタイトル]
|
||||
カスタムタイトルのノート。
|
||||
これはカスタムタイトルの付いた注釈ブロックです。
|
||||
:::
|
||||
```
|
||||
|
||||
### 効果
|
||||
|
||||
> [!NOTE]
|
||||
> 基本的な情報内容。
|
||||
> 内容を流し読みする場合でも、ユーザーに知ってほしい有益な情報。
|
||||
|
||||
> [!TIP]
|
||||
> 実用的なヒント。
|
||||
> タスクをよりスムーズに完了するために役立つオプション情報。
|
||||
|
||||
> [!IMPORTANT]
|
||||
> 重要なお知らせ。
|
||||
> タスクを完了するためにユーザーが必要とする重要な情報。
|
||||
|
||||
:::warning
|
||||
緊急の事項説明。
|
||||
ユーザーの即時の注意を必要とする潜在的なリスクがある重要な内容。
|
||||
:::
|
||||
|
||||
:::caution
|
||||
深刻なリスク警告。
|
||||
特定の操作によって生じる可能性のある悪影響について。
|
||||
:::
|
||||
|
||||
:::note[カスタムタイトル]
|
||||
カスタムタイトルのノート。
|
||||
これはカスタムタイトルの付いた注釈ブロックです。
|
||||
:::
|
||||
|
||||
## 動画
|
||||
|
|
|
|||
|
|
@ -52,8 +52,18 @@ abbrlink: markdown-extended-features
|
|||
> [!NOTE]
|
||||
> Полезная информация, которую пользователи должны знать, даже при беглом просмотре.
|
||||
|
||||
:::note
|
||||
Полезная информация, которую пользователи должны знать, даже при беглом просмотре.
|
||||
> [!TIP]
|
||||
> Полезные советы, как делать что-то лучше или проще.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Ключевая информация, которую пользователи должны знать для достижения своей цели.
|
||||
|
||||
:::warning
|
||||
Срочная информация, требующая немедленного внимания пользователя для предотвращения проблем.
|
||||
:::
|
||||
|
||||
:::caution
|
||||
Предупреждает о рисках или негативных последствиях определённых действий.
|
||||
:::
|
||||
|
||||
:::note[ПОЛЬЗОВАТЕЛЬСКИЙ ЗАГОЛОВОК]
|
||||
|
|
|
|||
|
|
@ -50,38 +50,48 @@ abbrlink: markdown-extended-features
|
|||
|
||||
```
|
||||
> [!NOTE]
|
||||
> 基礎的信息內容。
|
||||
> 即使快速瀏覽，也值得用戶留意的信息。
|
||||
|
||||
:::note
|
||||
基礎的信息內容。
|
||||
> [!TIP]
|
||||
> 可選信息，幫助用戶更順利地完成任務。
|
||||
|
||||
> [!IMPORTANT]
|
||||
> 用戶完成任務必需的關鍵信息。
|
||||
|
||||
:::warning
|
||||
存在潛在風險，需用戶立即關注的重要內容。
|
||||
:::
|
||||
|
||||
:::caution
|
||||
某些操作可能帶來的負面影響。
|
||||
:::
|
||||
|
||||
:::note[自定義標題]
|
||||
自定義標題的提示塊。
|
||||
這是一個自定義標題的提示塊。
|
||||
:::
|
||||
```
|
||||
|
||||
### 效果
|
||||
|
||||
> [!NOTE]
|
||||
> 基礎的信息內容。
|
||||
> 即使快速瀏覽，也值得用戶留意的信息。
|
||||
|
||||
> [!TIP]
|
||||
> 實用的提示建議。
|
||||
> 可選信息，幫助用戶更順利地完成任務。
|
||||
|
||||
> [!IMPORTANT]
|
||||
> 重要的通知提醒。
|
||||
> 用戶完成任務必需的關鍵信息。
|
||||
|
||||
:::warning
|
||||
緊急的事項說明。
|
||||
存在潛在風險，需用戶立即關注的重要內容。
|
||||
:::
|
||||
|
||||
:::caution
|
||||
嚴重的風險警告。
|
||||
某些操作可能帶來的負面影響。
|
||||
:::
|
||||
|
||||
:::note[自定義標題]
|
||||
自定義標題的提示塊。
|
||||
這是一個自定義標題的提示塊。
|
||||
:::
|
||||
|
||||
## 視頻
|
||||
|
|
|
|||
|
|
@ -50,38 +50,48 @@ abbrlink: markdown-extended-features
|
|||
|
||||
```
|
||||
> [!NOTE]
|
||||
> 基础的信息内容。
|
||||
> 即使快速浏览，也值得用户留意的信息。
|
||||
|
||||
:::note
|
||||
基础的信息内容。
|
||||
> [!TIP]
|
||||
> 可选信息，帮助用户更顺利地完成任务。
|
||||
|
||||
> [!IMPORTANT]
|
||||
> 用户完成任务必需的关键信息。
|
||||
|
||||
:::warning
|
||||
存在潜在风险，需用户立即关注的重要内容。
|
||||
:::
|
||||
|
||||
:::caution
|
||||
某些操作可能带来的负面影响。
|
||||
:::
|
||||
|
||||
:::note[自定义标题]
|
||||
自定义标题的提示块。
|
||||
这是一个自定义标题的提示块。
|
||||
:::
|
||||
```
|
||||
|
||||
### 效果
|
||||
|
||||
> [!NOTE]
|
||||
> 基础的信息内容。
|
||||
> 即使快速浏览，也值得用户留意的信息。
|
||||
|
||||
> [!TIP]
|
||||
> 实用的提示建议。
|
||||
> 可选信息，帮助用户更顺利地完成任务。
|
||||
|
||||
> [!IMPORTANT]
|
||||
> 重要的通知提醒。
|
||||
> 用户完成任务必需的关键信息。
|
||||
|
||||
:::warning
|
||||
紧急的事项说明。
|
||||
存在潜在风险，需用户立即关注的重要内容。
|
||||
:::
|
||||
|
||||
:::caution
|
||||
严重的风险警告。
|
||||
某些操作可能带来的负面影响。
|
||||
:::
|
||||
|
||||
:::note[自定义标题]
|
||||
自定义标题的提示块。
|
||||
这是一个自定义标题的提示块。
|
||||
:::
|
||||
|
||||
## 视频
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue