Read the Docs:簡化文件管理
Read the Docs simplifies managing software documentation by building and hosting your docs automatically, using the Git workflow you already use for code. Treating documentation like code lets your team use tools they already know, and makes keeping your docs updated easier.
- 最新的文件
每當您將程式碼推送到 Git 時,Read the Docs 都會自動建置您的文件,確保您的程式碼與文件始終保持同步。請參考我們的教學開始使用。
- 每個版本的文件
Read the Docs can host multiple versions of your docs. Keep your 1.0 and 2.0 documentation online, pulled directly from Git. Start hosting all your versions.
- 開源且以使用者為中心
Our company is bootstrapped and 100% user-focused, so our product gets better for our users instead of our investors. Read the Docs Community hosts documentation for over 100,000 large and small open source projects at no cost. Read the Docs for Business supports hundreds of organizations with product and internal documentation. Learn more about these differences on our pricing page.
First time here?
We have a few places for you to get started:
- Read the Docs 教學
Follow the Read the Docs tutorial.
- 熱門文件工具
MkDocs 與 Docusaurus 的快速使用。
- 範例專案
Start your journey with an example project to learn how to use Read the Docs.
專案設定與組態
Start with the basics of setting up your project:
- Configuration file overview
Learn how to configure your project with a
.readthedocs.yamlfile.- How to create reproducible builds
Keep your builds working by making them reproducible.
Build process
輕鬆建置您的文件:
- Build process overview
了解文件建置的運作方式。
- 拉取請求預覽
設定提取請求建置,並享受每次提交的預覽功能。
託管文件
深入了解我們的託管功能:
- Versions
Give your readers multiple versions of your documentation.
- 子專案
在單一網域下託管多個專案。
- 在地化與國際化
將您的文件翻譯成多種語言。
- URL versioning schemes
了解不同的網址版本控制方案。
- 自訂域名
Brand your documentation on your own domain.
維護專案
All the tools you need as your project matures:
- Redirects
將舊網址重新導向至新網址。
- Traffic analytics
深入了解使用者如何與您的文件進行互動。
- Security logs
追蹤專案中的安全性事件。
Business features
Our Business hosting has everything your business needs:
- Organizations
Manage permissions across multiple teams.
- 單一登入(SSO)
Stay secure with single sign-on.
- Sharing private documentation
Share your private docs easily with contractors or customers.
操作指南
Step-by-step guides for common tasks:
- How to configure pull request builds
設定提取請求建置,並享受每次提交的預覽功能。
- How to use cross-references with Sphinx
Learn how to use cross-references in a Sphinx project.
- All how-to guides
瀏覽我們所有的操作指南。
Reference
更多關於 Read the Docs 的詳細資訊:
- Public REST API
將 Read the Docs 整合到您的其他工作流程中。
- 變更日誌
See what's new in Read the Docs.
- 關於 Read the Docs
Learn more about Read the Docs and our company.