The Hypothesis editor supports formatting your annotations using Markdown — this help article serves as a “cheat sheet” for using Markdown syntax in the annotation editor.
Hypothesis 编辑器支持使用 Markdown 格式化您的注释-本帮助文章可作为在注释编辑器中使用 Markdown 语法的“备忘单”。
Also see our articles on adding links and images, embedding videos, and formatting annotations using LaTeX.
另请参阅我们关于添加链接和图片、嵌入视频以及使用 LaTeX 格式化注释的文章。
Want to print this sheet out? Here’s a printable PDF.
想要打印这张表格吗？这里有可打印的 PDF 文件。
| Style 风格 | Syntax 句法 | Example 示例 | Result 结果 |
|---|---|---|---|
| Headings 标题 | # H1
## H2 ### H3 |
# Largest heading ## Smaller heading ### Even smaller |
Largest heading 最大的标题Smaller heading 较小的标题Even smaller 更小 |
| Bold 粗体 | **text** or __text__ **文本**或__文本__ |
**This text is bold** |
This text is bold 这段文字是粗体 |
| Italic 斜体 | *text* or _text_ *文本*或_文本_ |
*This text is italicized* |
This text is italicized 这段文字是斜体的 |
| Strikethrough 删除线 | ~~text~~ ~~文本~~ |
~~This text has been struck through~~ |
这段文字已被划掉 |
| Blockquote 引用 | > quoted text |
Here’s a quote: > quoted text |
Here’s a quote: 这里是一个引用：
|
| Ordered list 有序列表 | 1. First item 1. 第一项 2. Second item 2. 第二项 3. Third item 3. 第三项 |
Favorite colors: 1. Blue 2. Purple 3. Green |
Favorite colors: 喜欢的颜色：
|
| Unordered list 无序列表 | – First item - 第一项
– Second item 第二项 – Third item - 第三项 |
Grocery list: - Coffee - Tea - Milk |
Grocery list: 购物清单：
|
| Inline code 内联代码 | `code` 代码 |
Run `make dev` to start the server |
Run make dev to start the server运行 make dev 以启动服务器 |
| Horizontal rule 水平规则 |
--- |
Starting a new section --- (notice the empty line between the text and horizontal rule) |
Starting a new section 开始一个新的部分
|
Previewing your annotation
预览您的注释
You can click “Preview” in the annotation editor toolbar to see what your formatted annotation will look like:
您可以在注释编辑器工具栏中点击“预览”以查看您格式化的注释将会是什么样子：
…and you can click “Write” to continue editing your annotation:
…您可以点击“撰写”继续编辑您的注释：
Troubleshooting annotation formatting
排除注释格式问题
- If you are copying annotation text from another source (Microsoft Word, Google Docs, etc), paste the text without formatting. You can do this with Option+Shift+Command+V for Macs or Ctrl+Shift+V for PCs.
如果您要从另一个来源（如 Microsoft Word、Google Docs 等）复制注释文本，请粘贴无格式的文本。您可以使用 Mac 上的 Option+Shift+Command+V 或 PC 上的 Ctrl+Shift+V 来执行此操作。 - Ensure there is an empty line between paragraph text and horizontal rules.
确保段落文本和水平规则之间有空行。 - Experiment with hitting Enter or Return once vs. twice if you encounter line break issues.
尝试按一次回车键或两次回车键，如果遇到换行问题。 - Consult the GitHub Flavored Markdown spec or create a ticket to get help from the Hypothesis team.
请参阅 GitHub Flavored Markdown 规范或创建一个工单以从 Hypothesis 团队获取帮助。