【Android -- 写作工具】Markdown 代码块

2023-11-11

在这里插入图片描述

1. 前言

关于代码块,Markdown 作者给出的定义如下:

预格式化代码块主要用于在 Markdown 文档中显示源代码风格的内容。相比普通的文本段落,代码块可以保留文字内容的多行换行、缩进等格式。

在 Markdown 文档中生成代码块,需要在每行的开头输入不少于 4 个空格符号或者 1 个 tab 符号。

Markdown 作为一种排版工具语言,其作用是为了帮助我们处理一些常见的排版问题。但是我们仍有一些场景需要保留文字的原格式,例如不同的缩进、中间空格数量等。Markdown 通过代码块的方式处理需要保存格式的多行文字内容。

环境说明:
考虑到 Markdown 工具之间的不兼容,有的内容直接从页面复制粘贴到本地不会正常显示,大家学习时自己动手写是肯定没问题的。本节所有实例代码及演示效果均使用 Typora 工具完成。

2. 语法详解

2.1 代码块
在 Markdown 文件中,在行首添加 4 个连续的空格,可将行内容定义为代码块。

实例 1:

#### 使用空格定义代码块

    pubic static void main(String[] args) {
      System.out.println("Hello world");
    }

其渲染结果如下:
在这里插入图片描述
注意:Typora 编辑器在默认模式(实时渲染模式)下无法通过此方法生成代码块,需要先切换到源代码模式(「显示」->「源代码模式」)后添加空格。

该源码渲染输出 html 的内容如下:

<pre>
<div><span><span>pubic static void main(String[] args) {</span></span></div>
<div><span><span>  </span><span>System.out.println("Hello world");</span></span></div>
<div><span><span>}</span></span></div>
</pre>

代码块的另一种定义方式是以三个连续的 「反引号 “`”」 作为开始行和结束行。

实例 2:

#### 使用反引号定义代码块

​```
pubic static void main(String[] args) {
  System.out.println("Hello world");
}
​```

其渲染结果如下:
在这里插入图片描述
在这种方式下,我们还可以声明代码的高亮样式,方法是在首行的连续的三个 「反引号 “`”」 后面加入源代码语言的标记,比如:javascript、Markdown、json、java、c++、sql 等,具体支持的种类和使用的 Markdown 编辑器或渲染程序配置有关。

实例 3:

#### 使用反引号定义代码块,并定义高亮

​```java
pubic static void main(String[] args) {
  System.out.println("Hello world");
}
​```

其渲染结果如下:
在这里插入图片描述

3. 使用场景及应用实例

行内代码功能可以让我们很轻松的在文章文字内容中间增加诸如 标签的内容,而不需要手动转义。当我们编写程序说明文档时,或者其他需要在文档中插入特殊字符时,这个功能的作用会非常明显。

实例 4:

画一张字符画。

#### 一张字符画

​```
.__           .__  .__                               .__       .___
|  |__   ____ |  | |  |   ____   __  _  _____________|  |    __| _/
|  |  _/ __ |  | |  |  /  _    / / /  _ _  __   |   / __ |
|   Y    ___/|  |_|  |_(  <_> )       (  <_> )  | /  |__/ /_/ |
|___|  /___  >____/____/____/    /_/ ____/|__|  |____/____ |
     /     /                                                  /
​```

渲染结果如下:
在这里插入图片描述

4. 小结

  • 当使用 4 个空格声明代码块时,转换后的代码文本会自动删除掉缩进的距离,也就是会从行首自动删掉 4 个空格,以保持格式;
  • 当使用 4 个空格声明代码块时,代码块的结束声明在后面首个缩进不足 4 个空格的行;
  • 常规的 Markdown 语义,比如「星号 *」在代码块中的转义作用失效。

「代码块」和「行内代码」都是方便于显示特殊字符,相比「行内代码」,「代码块」更有利于显示段落文本,表现出原文本的换行及缩进效果。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

【Android -- 写作工具】Markdown 代码块 的相关文章

  • Angular - 使用 \n 渲染 Markdown

    我正在尝试在 Angular 应用程序中渲染 Markdown 我正在使用ngx markdown https github com jfcere ngx markdown与 Angular 5 一起使用 效果很好 但是 我必须升级到 An
  • 在 Markdown 中更改美人鱼主题

    除了代码之外 我在 Markdown 文档中使用 mermaid 进行基本图表渲染 我发现这个在线编辑器 https mermaidjs github io mermaid live editor 在预览时对其进行编辑很有用 这建议更改主题
  • 无法将 imgur 上的 gif 嵌入到 github 上的 README.md 中

    我想在 README md 上显示一个大 gif 首先 我把它上传到imgur 然后 我将 url 添加到 README md img alt YAP src http i imgur com dNYswmI gif 但无法加载 编译为 a
  • Pagedown markdown 脚本插入图像 url 一次

    我有一个修改后的 pagedown markdown 标记脚本 用于将图像 url 插入编辑器 但它仅在第一次起作用 我已经用注释解释了我的代码
  • R Markdown 中未定义 Tex Proof 环境,生成的 Tex 文件中未定义 amsthm

    编辑以提供更多信息 我正在使用以下 R markdown 文件来生成以下 Tex 文件 我在 rmd 标头中包含 amsthm 它生成一个没有 amsthm 的 Tex 文件 因此 在编译期间并未定义证明环境 这是我的 rmd 文件 tit
  • 无法在 GitHub 上呈现标头

    这是我的README md在 GitHub 存储库中 This is a Header This is not a Header 这两行都呈现为纯文本 第一个应该呈现为标题 我记得它之前是这样的 我不知道我的浏览器 macOS 上的 Chr
  • 带有特定乳胶模板的 bookdown

    我非常相信 Rmarkdown 和 bookdown 是内容出版的未来 但是一些出版商使用特定的 LaTeX 模板 并且为了提交手稿 他们需要在该精确的模板中使用它 例如 请参阅此施普林格手稿模板 http resource cms spr
  • pelican:如何在 Markdown 中嵌入 html 和 javascript

    我想在博客文章中嵌入一些 html 元素和 javascript 这是我的 Markdown 文件 Title Foo Tags Bar Some Content here div div 但是 pelican 将 html 标签包装在pr
  • 是否有 Swift 代码的 Github markdown 语言标识符?

    我在用着https jbt github io markdown editor https jbt github io markdown editor在线文档工具 我想知道是否有一个标识符可以识别 swift 语法元素 谢谢 swift s
  • 带有 Pandoc 的内联 CSS

    如果在某处记录了以编程方式实现此目的的简单方法 不是通过在浏览器字段中复制 粘贴并单击按钮进行转换 我深表歉意 在我的搜索和阅读中我找不到它 我想以编程方式将 Markdown 和 CSS 文件转换为听起来可能称为 内联 CSS 的文件 例
  • .rmd 文件的访问名称并在 R 中使用

    我正在编织一个名为MyFile rmd 我如何访问该字符串MyFile在编织过程中并将其用于 在 YAML 标头的标题部分中使用 在后续的 R 块中使用 title r rmarkdown metadata title author My
  • 关于:链接(Markdown 页面)上的blank#blocked

    在 Markdown 页面中 Microsoft TFS Wiki 我尝试创建 A 标签file link a href file txt a 点击 Chrome 后 我得到了 about blank blocked 这不是 Chrome
  • 如果我设置 echo=FALSE,R Markdown 会使自定义绘图消失

    我创建了一个自定义函数 它将 mfrow 设置为 nxn 并根据数据框的输入列表创建 n 2 个散点图 每个图上有多个数据集 我的绘图函数的签名如下所示 plot return list lt function df list num pl
  • 在 R Markdown 文件中嵌入 pdf 并调整分页

    我即将完成博士学位 我需要在 R Markdown 文本中间的某个位置嵌入一些论文 pdf 格式 将 R Markdown 转换为 PDF 时 我希望将这些 PDF 论文嵌入到转换中 但是 我希望这些 PDF 论文也根据 Markdown
  • 使用 KnitR 在 R 中以编程方式创建 Markdown 表

    我刚刚开始了解 KnitR 以及使用 Markdown 生成 R 文档和报告 这对于我与工作有关的许多日常报告来说似乎是完美的 然而 我没有看到的一件事是使用 Markdown 格式打印数据框和表格的简单方法 有点像xtable 但使用 M
  • 如何将 Markdown 文档批量转换为 HTML?

    我正在用 Markdown 编写一些文档 并为文档的每个部分创建一个单独的文件 我希望能够一次性将所有文件转换为 HTML 但我找不到其他人尝试过同样的事情 我使用的是 Mac 所以我认为一个简单的 bash 脚本应该能够处理它 但我从未在
  • 摆脱 Sphinx 中的“重复标签”警告

    在 Sphinx 中 我收到大量警告 例如 PATH FILENAME LINE WARNING duplicate label LABELNAME other instance in PATH FILENAME 似乎将所有节标题视为 标签
  • 从 markdown 转换为 pandoc 时的 \newcommand 环境

    我使用 ipython 笔记本输入数学 然后转换为乳胶 让 mathjax 理解 newcommand 我必须把它放进去 例如 newcommand cl operatorname cl 与 mathjax 配合良好 问题是 当我使用 pa
  • 将 Powershell 输出转换为 Markdown 文件

    我有以下代码 xmlFile C Users kraer Desktop bom xml xml xml Get Content xmlFile xml bom components component ForEach Object fin
  • 我可以将更大的字体文本添加到 https://portal.azure.com 仪表板上的 Markdown 小部件吗?

    In https portal azure com https portal azure com我想制作一个带有大标签的仪表板 我们的想法是 我们可以在大电视上获取统计数据 这样我们就可以一目了然地看到我们的服务状态 大厂牌会成功的更容易消

随机推荐