zlei6/ragflow
1
0
Fork 0
mirror of https://github.com/infiniflow/ragflow.git synced 2026-09-08 10:14:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix markdownlint and command issues across READMEs (#17261)

Browse Source 
Fixes markdownlint findings and two carried-over command bugs that exist
identically across `README.md` and all translations (markdownlint just
never ran on them):

- **MD045** — alt text on documentation images.
- **MD014** — drop `$ ` prompts from command blocks with no output.
- **MD040** — language on the `/etc/hosts` fenced block; remove a stray
empty code block in `README_tzh.md`.
- `sudo brew install jemalloc` → `brew install jemalloc` (brew rejects
sudo).
- Infinity migration: the `up` command now uses
`docker/docker-compose.yml`, matching its `down`.

MD028 is intentionally left: its only fix folds a note into the
preceding `[!CAUTION]`/`[!WARNING]` admonition.

Split out of #17240 to keep that PR scoped to the Russian translation.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
deadtrickster
2026-07-22 16:47:58 +03:00
committed by GitHub
parent 92c1a232a3
commit dccc0a4bee
10 changed files with 168 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -17
View File
@@ -47,7 +47,7 @@
</h4>
<div align="center" style="margin-top:20px;margin-bottom:20px;">
<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/refs/heads/image/image/ragflow-octoverse.png" width="1200"/>
<img alt="RAGFlow in the GitHub Octoverse" src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/refs/heads/image/image/ragflow-octoverse.png" width="1200"/>
</div>
<div align="center">
@@ -82,8 +82,8 @@
Try our cloud service at [https://cloud.ragflow.io](https://cloud.ragflow.io).
<div align="center" style="margin-top:20px;margin-bottom:20px;">
<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/refs/heads/image/image/chunking.gif" width="1200"/>
<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/refs/heads/image/image/agentic-dark.gif" width="1200"/>
<img alt="Chunking demonstration" src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/refs/heads/image/image/chunking.gif" width="1200"/>
<img alt="Agentic workflow demonstration" src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/refs/heads/image/image/agentic-dark.gif" width="1200"/>
</div>
## 🔥 Latest Updates
@@ -107,7 +107,7 @@ Try our cloud service at [https://cloud.ragflow.io](https://cloud.ragflow.io).
releases! 🌟
<div align="center" style="margin-top:20px;margin-bottom:20px;">
<img src="https://github.com/user-attachments/assets/18c9707e-b8aa-4caf-a154-037089c105ba" width="1200"/>
<img alt="RAGFlow feature updates" src="https://github.com/user-attachments/assets/18c9707e-b8aa-4caf-a154-037089c105ba" width="1200"/>
</div>
## 🌟 Key Features
@@ -142,7 +142,7 @@ releases! 🌟
## 🔎 System Architecture
<div align="center" style="margin-top:20px;margin-bottom:20px;">
<img src="https://github.com/user-attachments/assets/31b0dd6f-ca4f-445a-9457-70cb44a381b2" width="1000"/>
<img alt="RAGFlow system architecture" src="https://github.com/user-attachments/assets/31b0dd6f-ca4f-445a-9457-70cb44a381b2" width="1000"/>
</div>
## 🎬 Self-Hosting
@@ -166,14 +166,14 @@ releases! 🌟
> To check the value of `vm.max_map_count`:
>
> ```bash
> $ sysctl vm.max_map_count
> sysctl vm.max_map_count
> ```
>
> Reset `vm.max_map_count` to a value at least 262144 if it is not.
>
> ```bash
> # In this case, we set it to 262144:
> $ sudo sysctl -w vm.max_map_count=262144
> sudo sysctl -w vm.max_map_count=262144
> ```
>
> This change will be reset after a system reboot. To ensure your change remains permanent, add or update the
@@ -186,7 +186,7 @@ releases! 🌟
2. Clone the repo:
```bash
$ git clone https://github.com/infiniflow/ragflow.git
git clone https://github.com/infiniflow/ragflow.git
```
3. Start up the server using the pre-built Docker images:
@@ -197,14 +197,14 @@ releases! 🌟
> The command below downloads the `v0.26.4` edition of the RAGFlow Docker image. See the following table for descriptions of different RAGFlow editions. To download a RAGFlow edition different from `v0.26.4`, update the `RAGFLOW_IMAGE` variable accordingly in **docker/.env** before using `docker compose` to start the server.
```bash
$ cd ragflow/docker
cd ragflow/docker
git checkout v0.26.4
# Optional: use a stable tag (see releases: https://github.com/infiniflow/ragflow/releases)
# This step ensures the **entrypoint.sh** file in the code matches the Docker image version.
# Use CPU for DeepDoc tasks:
$ docker compose -f docker-compose.yml up -d
docker compose -f docker-compose.yml up -d
# To use GPU to accelerate DeepDoc tasks:
# sed -i '1i DEVICE=gpu' .env
@@ -223,7 +223,7 @@ releases! 🌟
4. Check the server status after having the server up and running:
```bash
$ docker logs -f docker-ragflow-cpu-1
docker logs -f docker-ragflow-cpu-1
```
_The following output confirms a successful launch of the system:_
@@ -273,7 +273,7 @@ to `<YOUR_SERVING_PORT>:80`.
Updates to the above configurations require a reboot of all containers to take effect:
> ```bash
> $ docker compose -f docker-compose.yml up -d
> docker compose -f docker-compose.yml up -d
> ```
### Switch doc engine from Elasticsearch to Infinity
@@ -283,7 +283,7 @@ RAGFlow uses Elasticsearch by default for storing full text and vectors. To swit
1. Stop all running containers:
```bash
$ docker compose -f docker/docker-compose.yml down -v
docker compose -f docker/docker-compose.yml down -v
```
> [!WARNING]
@@ -293,7 +293,7 @@ RAGFlow uses Elasticsearch by default for storing full text and vectors. To swit
3. Start the containers:
```bash
$ docker compose -f docker-compose.yml up -d
docker compose -f docker/docker-compose.yml up -d
```
> [!WARNING]
@@ -347,7 +347,7 @@ docker build --platform linux/amd64 \
Add the following line to `/etc/hosts` to resolve all hosts specified in **docker/.env** to `127.0.0.1`:
```
```text
127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager
```
4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site:
@@ -365,7 +365,7 @@ docker build --platform linux/amd64 \
# OpenSUSE
sudo zypper install jemalloc
# macOS
sudo brew install jemalloc
brew install jemalloc
```
6. Launch backend service:
@@ -388,7 +388,7 @@ docker build --platform linux/amd64 \
_The following output confirms a successful launch of the system:_
![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187)
![RAGFlow web interface](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187)
9. Stop RAGFlow front-end and back-end service after development is complete:
```bash