前端 - 怎么查看 readthedocs.io 上某个文档的原始 markdown 是什么？

Question

比如 https://fastapi-login.readthedocs.io/advanced_usage/ 这个文档，我想知道他的代码蓝色标记和红色的警告块是怎么来的

这看起来不是 markdown 本身支持的语法吧？是 readthedocs 提供的扩展语法吗？

Answer 1

https://github.com/maxrdu/fastapi_login/blob/master/docs/advanced_usage.md?plain=1

看上去应该是某个扩展语法。

Answer 2

文档源码：

https://github.com/maxrdu/fastapi_login/blob/master/docs/advanced_usage.md

---

Read the Docs 支持很多 Markdown 的扩展语法，包括 MkDocs、MyST 等等。

https://docs.readthedocs.com/platform/stable/intro/doctools.html

你提到的文档使用的是 MkDocs 语法，并且使用了 Material for MkDocs 这个主题框架。这点可以从其 repo 根目录下的 .mkdocs.yml 得知。

你提到的第一个代码行高亮的特性，叫 Code block with highlighted lines :

https://squidfunk.github.io/mkdocs-material/reference/code-bl...

你提到的第二个标记块的特性，叫 Admonitions :

https://squidfunk.github.io/mkdocs-material/reference/admonit...