跳至內容

cargo-rdme

軟體分類 DevOps 與雲端維運 (DevOps & Cloud) / CI/CD 自動化 (CI/CD Pipelines)
開發廠商 orium
Stars
176
Forks
9
License
MIT
Version
vv1.5.0
Update
2026-01-24
OS

#### 產品特色

* 支援從程式碼中自動產生繁體中文的README文件
* 自動處理Rust程式碼塊,去除隱藏行與標記
* 支援內聯連結到crate::…格式的項目
* 可自定義README文件路徑與行分隔符
* 整合CI系統驗證README文件與程式碼一致性

#### 主要功能、特點

透過執行cargo rdme命令,自動將程式碼的Documentation轉換為適合閱讀的README文件。支援自動處理Rust程式碼塊,去除隱藏行與標記,並自動生成內聯連結到docs.rs的連結。可自定義README文件路徑與行分隔符,並整合CI系統驗證README文件與程式碼一致性。

#### 指令

“`bash
# 無常用指令(自動生成)
“`