From 0be571efbe66d40614f80455b38ba0df8a429959 Mon Sep 17 00:00:00 2001 From: XPoet Date: Mon, 1 Mar 2021 10:32:04 +0800 Subject: [PATCH] docs: update README --- README.md | 11 +++++++---- README_zh-CN.md | 11 +++++++---- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index da65b95..b5786cf 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,8 @@ ## :star2: Online Preview - **[XPoet's Blog](https://xpoet.cn/)** -- **[keep official website](https://keep.xpoet.cn/)** +- **[Keep demo website](https://keep.xpoet.cn/)** +- **[Keep official document](https://keep-docs.xpoet.cn/)** ## :rocket: Installation @@ -46,11 +47,13 @@ theme: keep ## :wrench: Usage -See docs: +Please see the official documents of «Keep». -- [Keep theme usage guide](https://keep.xpoet.cn/2020/04/Keep-主题使用指南/) +- **[Keep official document](https://keep-docs.xpoet.cn/)** -- [Keep theme configuration guide](https://keep.xpoet.cn/2020/11/Keep-主题配置指南/) +- **[Keep theme configuration guide](https://keep-docs.xpoet.cn/usage-tutorial/configuration-guide.html)** + +- **[Keep theme advanced usage](https://keep-docs.xpoet.cn/usage-tutorial/advanced.html)** It is not recommended to directly modify any files in the «Keep» theme. Because this may cause errors (e.g. merge conflicts), and the modified files may be discarded when upgrading the theme. diff --git a/README_zh-CN.md b/README_zh-CN.md index 6c21463..e4329fe 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -20,7 +20,8 @@ ## :star2: 在线预览 - **[XPoet's Blog](https://xpoet.cn/)** -- **[keep 官网](https://keep.xpoet.cn/)** +- **[keep 演示网站](https://keep.xpoet.cn/)** +- **[keep 官方文档](https://keep-docs.xpoet.cn/)** ## :rocket: 安装 @@ -46,11 +47,13 @@ theme: keep ## :wrench: 使用 -查看文档: +请查看 «Keep» 官方文档: -- [Keep 主题使用指南](https://keep.xpoet.cn/2020/04/Keep-主题使用指南/) +- **[Keep 官方文档](https://keep-docs.xpoet.cn/)** -- [Keep 主题配置指南](https://keep.xpoet.cn/2020/11/Keep-主题配置指南/) +- **[Keep 主题配置指南](https://keep-docs.xpoet.cn/usage-tutorial/configuration-guide.html)** + +- **[Keep 主题进阶使用](https://keep-docs.xpoet.cn/usage-tutorial/advanced.html)** 不推荐直接修改 «Keep» 主题的文件。因为这可能导致错误(例如 git merge 冲突),并且在升级主题时修改的文件可能丢失。