Logo

Getting started

  • Tutorial
  • 增添文件專案
  • 熱門文件工具
    • Deploying Sphinx on Read the Docs
    • Deploying MkDocs on Read the Docs
    • Deploying Docusaurus on Read the Docs
    • Deploying Markdoc on Read the Docs
    • Deploying mdBook on Read the Docs
    • Deploying VitePress on Read the Docs
    • Deploying Antora on Read the Docs
    • Deploying Zensical on Read the Docs
    • Deploying MyST Markdown on Read the Docs
  • 範例專案

專案設定與組態

  • Configuration file overview
  • Configuration file reference
  • Read the Docs Addons
  • Account authentication methods
  • Automation rules
  • How to create reproducible builds

Build process

  • Build process overview
  • Build process customization
  • Git integration (GitHub, GitLab, Bitbucket)
  • 拉取請求預覽
  • 建置失敗通知
  • 環境變數概覽
  • 環境變數參考

託管文件

  • Versions
  • 子專案
  • 在地化與國際化
  • URL versioning schemes
  • 自訂域名
  • URL path prefixes
  • 文件通知
  • Canonical URLs
  • Content Delivery Network (CDN) and caching
  • Sitemap support
  • 404 Not Found pages
  • robots.txt support
  • llms.txt support

閱讀文件

  • Offline formats (PDF, ePub, HTML)
  • Visual diff
  • 連結預覽
  • How to embed content from your documentation
  • Server side search
  • 搜尋查詢語法
  • 飛出式選單

維護專案

  • Redirects
  • Traffic analytics
  • Search analytics
  • Security logs
  • 狀態徽章
  • How to structure your documentation
  • Best practices for linking to your documentation
  • Security considerations for documentation pages
  • Main content detection
  • AI agent skills
  • Custom script

Business features

  • Business hosting
  • Organizations
  • 單一登入(SSO)
  • Sharing private documentation
  • 如何管理您的訂閱
  • Privacy levels

操作指南

  • 專案設定與組態
  • Build process
  • Upgrading and maintaining projects
  • Content, themes and SEO
  • Security and access
  • 帳號管理
  • 最佳實踐
  • Troubleshooting problems

Reference

  • Public REST API
  • 常見問題集
  • 變更日誌
  • 關於 Read the Docs
  • 開發者文件
  • Read the Docs 網站
Read the Docs user documentation
  • 熱門文件工具
  • Edit on GitHub

熱門文件工具

Read the Docs provides documentation hosting for any tool that can output HTML. We provide a number of features that are well-suited to documentation specifically, but you can host any kind of HTML content on Read the Docs.

Below is a list of popular documentation tools that you can use to write your documentation.

也參考

Build process customization Learn how to build documentation with any tool.

MkDocs

MkDocs is a powerful documentation tool for markdown.

Supported formats

md

Written in

python

mkdocs.html
Zensical

Zensical is a static-site generator built by the creators of Material for MkDocs.

Supported formats

md

Written in

rust python

zensical.html
Sphinx

Sphinx is a powerful documentation generator that has many features for writing technical documentation.

Supported formats

rst md

Written in

python

sphinx.html
Docusaurus

Docusaurus is a static-site generator that builds a single-page application with fast client-side navigation and out-of-the-box documentation features.

Supported formats

mdx md

Written in

React

docusaurus.html
Markdoc

Markdoc is a documentation tool developed by Stripe that allows you to write documentation in a custom Markdown flavor.

Supported formats

md

Written in

javascript

markdoc.html
mdBook

mdBook is a command line tool to create books with Markdown built in Rust.

Supported formats

md

Written in

rust

mdbook.html
VitePress

VitePress is a static site generator with a focus on performance and simplicity.

Supported formats

md

Written in

typescript

vitepress.html
Antora

Antora is a static site generator for creating documentation sites from AsciiDoc content.

Supported formats

adoc

Written in

javascript

antora.html
MyST Markdown

MyST Markdown is a powerful authoring framework for scientific communication including blogs, books, papers, and articles.

Supported formats

md ipynb

Written in

javascript

mystmd.html
Previous Next

© Copyright Read the Docs, Inc & contributors.

Built with Sphinx using a theme provided by Read the Docs.