mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-10-29 11:56:02 +08:00
doc: add README_EN.md
This commit is contained in:
@@ -8,12 +8,6 @@
|
||||
|
||||
文档基于 VitePress 生成,本地编写需要安装 Node 和 VitePress
|
||||
|
||||
### NodeJS
|
||||
|
||||
自行安装
|
||||
|
||||
### VitePress
|
||||
|
||||
Clone 本仓库,在目录下执行以下命令安装依赖:
|
||||
|
||||
```bash
|
||||
@@ -44,3 +38,7 @@ npm run docs:dev
|
||||
- 子文件(夹)的命名,**不加前缀**(即文件夹的名称),如:`deploy`文件夹下的,文件夹`langbot`,`langbot`文件夹下的`manual`文件称之为`manual.md`
|
||||
- 由于这是有关于文档的规范化命名,所以任何文件的名称都可以以教程的角度来理解,如`deploy`是有关部署的教程
|
||||
- 除了配置文件板块的文档,其他的页面都不要在顶部加目录
|
||||
|
||||
---
|
||||
|
||||
**[English README](README_EN.md)**
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
# [LangBot](https://github.com/langbot-app/LangBot) Official Documentation
|
||||
|
||||
> This repository is the documentation repository for LangBot. Code repository:
|
||||
> [LangBot Code Repository](https://github.com/langbot-app/LangBot)
|
||||
> This is the documentation for LangBot 4.0. For 3.0 documentation, please see the `v3` branch
|
||||
|
||||
## Contributing to Documentation
|
||||
|
||||
The documentation is generated based on VitePress. Local development requires Node and VitePress installation.
|
||||
|
||||
Clone this repository and execute the following command in the directory to install dependencies:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
After completion, you can modify the documentation. After modifications, use the following command to start locally:
|
||||
|
||||
```bash
|
||||
npm run docs:dev
|
||||
```
|
||||
|
||||
### Using Images
|
||||
|
||||
Place images in the `docs/assets/image` directory, then reference them using the absolute path when accessed via web, such as:
|
||||
|
||||
```markdown
|
||||

|
||||
```
|
||||
|
||||
### Deployment Details
|
||||
|
||||
Currently hosted on Cloudflare Pages. After submission, [@RockChinQ](https://github.com/RockChinQ) updates the branch for automatic deployment.
|
||||
|
||||
### Some Standardization Guidelines
|
||||
|
||||
- Folder and file naming: **Use all lowercase, separate words with `-`, such as** `plugin-intro.md`
|
||||
- Sub-file (folder) naming: **No prefix** (i.e., the folder name), such as: in the `deploy` folder, the folder `langbot`, the `manual` file in the `langbot` folder is called `manual.md`
|
||||
- Since this is about standardized naming for documentation, any file name can be understood from a tutorial perspective, such as `deploy` being about deployment tutorials
|
||||
- Except for configuration file section documents, other pages should not have a table of contents at the top
|
||||
|
||||
---
|
||||
|
||||
**[中文版 README](README.md)**
|
||||
Reference in New Issue
Block a user