feat(docs): 完成中文文档[介绍]篇

lexmin0412 · Apr 20, 2024 · 1322cfa · 1322cfa
1 parent 84c9337
commit 1322cfa
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 20 deletions.
diff --git a/packages/docs/docs/en/index.md b/packages/docs/docs/en/index.md
@@ -3,7 +3,7 @@ pageType: home
 
 hero:
   name: Readue
-  text: 一键生成你的项目 README 文档
+  text: One-Click README generator
   actions:
     - theme: brand
       text: Quick Start

diff --git a/packages/docs/docs/zh/guide/start/introduction.md b/packages/docs/docs/zh/guide/start/introduction.md
@@ -1,3 +1,63 @@
 # 介绍
 
-正文。
+## 定位
+
+Readue 是一个 README 一键式生成工具，它可以帮你免去从四处复制粘贴信息的烦恼，并始终保持和项目本身的一致性。你可以通过 CLI 来快速生成 README，可以在 可视化界面中预览内容，在 Github Actions 中持续集成，更可以通过 API 方式对多个项目的 README 进行批量更新。
+
+## 初衷
+
+Readue 是一个我筹划已久的项目，它主要致力于解决信息一致性的问题。
+
+### 信息一致性
+
+在开源项目中，README 文件是项目的重要文档之一。它通常包含项目的介绍、使用方法、贡献指南等。它是一个项目最直观的信息载体，我们在项目创建或者发布第一个发行版时，通常都会认真地书写 README 文件，以更好地向用户展示项目。
+
+但是随着项目的迭代，项目本身的内容也在不断变化，README 文件本应随之更新，但很遗憾地是，后期我们的重心往往会放在项目本身的功能迭代上，而 README 文件往往会被遗忘。
+
+因此，Readue 应运而生，它旨在帮助开发者在项目迭代的过程中，及时保持 README 内容与项目本身的一致性。
+
+## 功能特性
+
+接下来我们会介绍 Readue 的主要功能特性。
+
+### 1. 一键生成
+
+对于开源项目来说，在 README 文件中的很多内容都是类似的，比如项目信息、证书、Monorepo 的子包信息等。但我们却需要为每个项目都手动书写这些内容，这无疑会浪费大量的时间。
+
+使用 `@readue/cli` 工具在项目根目录执行 `readue`，即可一键写入 README。
+
+### 2. 配置块插件
+
+Readue 对于 README 的内容，视为一块一块的配置块，每个配置块都由一个单独的插件来负责，接受相同的信息，输出不同的内容，用户可以根据自己的需要，灵活自定义生成的信息。
+
+以 `lexmin0412/readue` 项目本身为例，它的配置信息如下：
+
+```js
+module.exports = {
+	...,
+	// 其他配置信息
+	blocks: {
+		type: 'custom',
+		list: [
+			"@readue/block-base_info",
+			"@readue/block-packages",
+			"@readue/block-star_history",
+		]
+	}
+}
+```
+
+它使用了 `@readue/block-base_info`、`@readue/block-packages` 和 `@readue/block-star_history 插件，Readue 会在运行过程中依次执行这些插件，并将它们返回的内容拼接起来，最终生成 README。
+
+当然，你也可以自定义自己的插件，来满足内置插件没有覆盖的需求。
+## 使用方式
+
+Readue 提供了 CLI 、API、可视化界面三种方式来生成 README，分别适用于不同的场景。
+
+| 生成方式   | 应用场景                                 |
+|------------|------------------------------------------|
+| CLI        | 命令行工具，适用于 CI/CD 场景            |
+| API        | Node.js API，适用于批量更新 README       |
+| 可视化界面 | 所见即所得，使用成本低，适用于一次性操作 |
+
+
diff --git a/packages/docs/docs/zh/index.md b/packages/docs/docs/zh/index.md
@@ -3,10 +3,11 @@ pageType: home
 
 hero:
   name: Readue
-  text: 一键生成你的项目 README 文档
+  text: 一键生成 README
+  tagline: 简单、快速、灵活自定义
   actions:
     - theme: brand
-      text: Quick Start
+      text: 快速开始
       link: /guide/start/quick-start
     - theme: alt
       text: Github
@@ -15,22 +16,13 @@ hero:
     src: https://lexmin0412.github.io/readue/rspress-icon.png
     alt: Readue Logo
 features:
-  - title: Blazing fast build speed
-    details: The core compilation module is based on the Rust front-end toolchain, providing a more ultimate development experience.
-    icon: 🏃🏻‍♀️
-  - title: Support for MDX content writing
-    details: MDX is a powerful way to write content, allowing you to use React components in Markdown.
+  - title: 简单
+    details: 最少只需一次点击，即可快速生成 README，并提供 CLI、API、可视化界面等多种方式，满足你的一切使用场景。
     icon: 📦
-  - title: Built-in full-text search
-    details: Automatically generates a full-text search index for you during construction, providing out-of-the-box full-text search capabilities.
+  - title: 快速
+    details: 生成时间约等于你眨一次眼睛的时长。
+    icon: 🏃🏻‍♀️
+  - title: 灵活自定义
+    details: 提供多种内置块，积木式自定义你的 README 结构，更可快速开发自定义块插件。
     icon: 🎨
-  - title: Simpler I18n solution
-    details: With the built-in I18n solution, you can easily provide multi-language support for documents or components.
-    icon: 🌍
-  - title: Static site generation
-    details: In production, it automatically builds into static HTML files, which can be easily deployed anywhere.
-    icon: 🌈
-  - title: Providing multiple custom capabilities
-    details: Through its extension mechanism, you can easily extend theme UI and build process.
-    icon: 🔥
 ---