导航
颜色主题
缩写为 reST,文件后缀为 rst。
reStructuredTextMarkup Syntax and Parser Component of Docutils
reStructuredText PrimerreStructuredText is the default plaintext markup language used by Sphinx. This section is a brief introduction to reStructuredText (reST) concepts and syntax, intended to provide authors with enough information to author documents productively.
reStructuredText markupThis document describes the custom reStructuredText markup introduced by Sphinx to support Python documentation and how it should be used.
AsciiDoc Language Documentationhttps://docs.asciidoctor.org/asciidoc/latest/
LaTeX 备忘清单本备忘单总结了 LaTeX 常用显示数学符号的参考列表和一些 KaTeX 的应用示例。
LaTeX cheatsheetThis cheat sheet summarizes a reference list of LaTeX commonly used display math notation and some application examples of KaTeX.
注意
Markdown 在不同环境下语法会有细微差别,实际渲染效果也不完全相同,请根据所在环境查找相应文档。
基本撰写和格式语法使用简单的语法在 GitHub 上为您的散文和代码创建复杂的格式。
Markdown 备忘清单https://quickref.cn/docs/markdown.html
Markdown cheatsheethttps://cheatsheets.zip/markdown
关于任务列表您可以使用任务列表将议题或拉取请求的工作分解为较小的任务,然后跟踪要完成的整套工作。
使用表格组织信息您可以创建表格来组织评论、议题、拉取请求和 wiki 中的信息。
警报警报是基于块引用语法的 Markdown 扩展,可用于强调关键信息。 在 GitHub 上,它们以独特的颜色和图标显示,以指示内容的显著性。
自定义容器自定义容器可以通过它们的类型、标题和内容来定义。
使用折叠部分组织信息可创建带 <details> 标记的折叠部分来简化 Markdown。
代码块中的语法高亮按照特定的语法对代码块中的文本进行着色。
在代码块中实现行高亮提升某一些行的亮度,以与其它行形成鲜明对比。
代码块中聚焦默认情况下模糊其它行,只保留某一些行的正常显示;在鼠标移动上去时显示所有的行。
代码块中的颜色差异使用红色、绿色表示代码中某一些行的增删改动,类似于 git 的展示效果。
代码块中的行号https://vitepress.dev/zh/guide/markdown#line-numbers
Bundled Languages - Shikihttps://shiki.style/languages
创建和突显代码块通过围栏代码块和启用语法突显来分享代码样本。
Mermaidhttps://mermaid.js.org/intro/
创建 Mermaid 关系图Mermaid 是一款受 Markdown 启发的工具,可将文本呈现为关系图。 例如,Mermaid 可以呈现流程图、序列图、饼图等。
提示
本质上是 LaTex 代码,参考其语法来编写即可,导航见本文LaTeX。
LaTeX cheatsheethttps://vitepress.dev/zh/guide/markdown#math-equations
编写数学表达式使用 Markdown 在 GitHub 上显示数学表达式。
自动链接引用和 URL对 URL、议题、拉取请求和提交的引用会自动缩短并转换为链接。
GitHub Flavored Markdown Spechttps://github.github.com/gfm/