aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/index.md')
-rw-r--r--docs/source/index.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/source/index.md b/docs/source/index.md
new file mode 100644
index 0000000..5c32c61
--- /dev/null
+++ b/docs/source/index.md
@@ -0,0 +1,46 @@
+---
+hide-toc: true
+---
+
+# GRPS
+
+```{include} ../../README.md
+:start-after: <!-- start index -->
+:end-before: <!-- end index -->
+```
+
+```{toctree}
+:hidden:
+
+简述 <index>
+```
+
+```{toctree}
+:hidden:
+
+快速开始 <quick-start>
+核心模块: core <pages/core>
+生成器: generator <pages/generator>
+处理器: handler <pages/handler>
+注入模块: injector <pages/injector>
+拦截器: interceptor <pages/interceptor>
+包引用: internal <pages/internal>
+注册器: register <pages/register>
+工作流: workflow <pages/workflow>
+```
+
+```{toctree}
+:caption: API 接口
+:hidden:
+
+阅读源码 <pages/api/index>
+```
+
+```{toctree}
+:caption: 开发手册
+:hidden:
+
+社区贡献指引 <CONTRIBUTING>
+变更日志 <changelog>
+协议 <license>
+```