在 Engee 中使用 Markdown
Markdown 是一种轻量级标记语言,设计用于编写结构化文本,在 Engee 中用于标记。它可用于注释、脚本编辑器文本单元格、.md 文件以及 Engee 中任何可使用 Markdown 编写文本的地方。 Engee*使用扩展的Markdown方言,除标准元素外,还支持常规标记中不存在的扩展元素(详见*Engee)。 扩展语法).
在脚本编辑器文本格式的工具栏中,标准 Markdown 元素与扩展元素之间有垂直分隔线:
基本语法
让我们来看看 Markdown 语言的基本语法:
标题
标题 - 使用 表示一级标题(最大的标题)。使用 表示二级标题,依此类推,直至第六级:
# 一级标题
## 二级标题...
...
###### 六级标题
文本选择_
-
文本选择* - 使用 * 或 _ 可以斜体显示文本。使用 * * * 或 _ _ 粗体显示文本。使用 ~ ~ ~ 来删除文本。
*斜体文本*
**半粗体文本**
~~删除线文本~~
列表。
列表 - 使用 *、- 或 + 创建无序列表。使用带点的数字创建有序列表。
* 列表项 1
* 列表项 2
1. 列表项 1
2. 列表项 2
公式
在 Engee 改用 KaTeX 之后,带有不含 欲了解更多信息和实现更复杂的语法,请参阅.KaTeX官方文档。 |
Markdown Engee 默认支持使用KaTeX 库显示 LaTeX 公式。
要正确显示公式,请用 $
将公式包起来:
-
$…$
- 用于单行公式,例如:$x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$
-
$$…$$
- 用于多行公式,例如:$$…$$
:$$ \frac{1}{\sigma \sqrt{2\pi}} \\ \cdot \exp\left( -\frac{(x - \mu)^2}{2\sigma^2} \right) $$
引言
引号 - 使用 > 创建引号。
> 您的引用。
代码
Code - 使用向后的撇号(回车键)""对文本进行包装,以插入单行代码。使用三个向后的撇号( ` ` ` ` )插入多行代码。
文本中的`代码`示例。
```
多行
代码
```
链接。
链接 - 使用"[链接文本](URL) "结构创建超链接。
[Engee文档](https://engee.com/helpcenter/stable/)
图片
Images - 使用标准结构`` 插入图像。例如

如果需要控制图片的对齐方式和大小,可以使用 HTML 或 CSS。以下是不同选项的示例:
选项代码. | 对齐类型 |
---|---|
|
默认值 |
|
左边缘 |
|
在中心 |
|
右边缘 |
|
以 `<center> 为中心 |
|
通过".centre "居中 |
如果通过`attachment:filename.png`使用本地图片,它们也支持 CSS 样式,如表格中的最后一个示例。
attachment:`是对附加到脚本编辑器的本地文件的特殊引用。交互式脚本格式 ngscript 和 ipynb 支持插入此类图片。要以 attachment: 的形式添加图像,只需将文件(例如 engee.png )从 *Engee*文件浏览器拖放到脚本编辑器单元格中,它就会自动以  的形式出现,并在预览中可见。
|
分隔符.
水平破折号 - 使用三个连字符 - - - - 或三个星号 * * * * 插入水平破折号。
---
***
表格。
Tables - 使用 | 和 - 创建表格。
| 标题1 | 标题2 |
| ----------- | ----------- |
| 单元格1 | 单元格2 |
| 单元格3 | 单元格4 |
或 WYSIWYG 中提供的替代语法:
#|
||
标题 1
|
标题 2
||
||
单元格 1
|
单元格 2
||
||
单元格 3
|
单元格 4
||
|#
扩展语法
使用扩展标记时,务必缩进内容,留出空行:
|
备注
注释* (note
)是一个突出显示的块,可引起对其所含信息的注意。根据上下文,您可以使用关键字 info
、tip
、warning
和 `alert`来使用不同类型的注释:
有关使用注释的更多信息。
类型 | 用途 | 举例说明 |
---|---|---|
|
附加信息。 |
[源文件,markdown]。 {% note info %} 这是注释。 {% endnote %} |
|
实用小贴士。 |
{% note tip %} 这是建议。 {% endnote %} |
警告(重要) |
警告可能存在的问题。 |
{% note warning %} 这是重要信息。 {% endnote %} |
|
限制或错误。 |
[source,markdown]. {% note alert %} 这是警告。 {% endnote %} |
您还可以为备注设置自己的标题或不设置标题:
<!-- 带标题的笔记 -->
{% note info “自己的标题” %}
这是带标题的笔记。
{% endnote %}
<!-- 无标题的笔记 -->
{% note info “” %}
这是无标题的笔记。
{% endnote %}
Cuts (cut
) - 用于隐藏部分内容。
了解更多有关大块的信息
例如,您可以隐藏附加信息或长代码块:
{% cut “目录标题” %}
点击后显示的内容。
{% endcut %}
Katy 默认不支持展开项目的功能。 |
标签 (tabs
) - 用于在不同部分之间切换,不会使页面杂乱无章
关于标签的更多信息
让我们以创建多个标签页为例:
{% list tabs %}
- 标签页名称 1
标签页文本 1。
- 标签页名称 2
标签页文本 2。
{% endlist %}
您还可以使用 {selected}
属性设置默认打开所需的选项卡:
{% list tabs %}
- 标签页名称 1
标签页文本 1。
- 标签页名称 2 {selected}
该标签页将默认打开。
{% endlist %}
可使用 group
属性同步标签页:
{% list tabs group=instructions %}
- Python
About python
- Java
About java
{% endlist %}
{% list tabs group=instructions %}
- Python
Duplicate python content
- Java
Duplicate java content
{% endlist %}
页面重新加载时,标签页的状态将被保留。 |
单选按钮 (tabs radio
) - 工作方式类似于标签页,但外观类似于切换按钮。
有关单选按钮的更多信息_.
让我们来看一个创建单选按钮的示例:
{% list tabs radio %}
- Linux
Linux操作指南
- Windows
Windows操作指南
{% endlist %}
与标签页一样,您可以使用 {selected}
设置默认选定项目:
{% list tabs radio %}
- macOS
操作指南
- Windows {selected}
此选项默认处于打开状态。
{% endlist %}
使用 Markdown,您可以将不同平台的视频嵌入到 Engee 中。具体方法如下
有关视频的更多信息_.
要从支持的视频托管服务中嵌入视频,请按照以下格式操作
@[主机名称](视频ID或链接)
要这样做
-
将托管名称替换为列表中的平台名称:
yandex
,rutube
,vk
,youtube
,vimeo
,vine
,osf
,prezi
。 -
转到视频页面并找到嵌入代码(在标签
<iframe>
中),然后从src
属性中复制链接(不带引号):<iframe src="https://vk.com/video_ext.php?oid=-207738372&id=456239060&hd=2&autoplay=1" width="853" height="480" allow="autoplay; encrypted-media; fullscreen; picture-in-picture; screen-wake-lock;" frameborder="0" allowfullscreen></iframe>
-
将
id_video_id_or_link_to_it
替换为src
属性中的链接。
示例将显示 VK 的视频播放器:
@[vk](https://vk.com/video_ext.php?oid=-207738372&id=456239060&hd=2&autoplay=1)
或者,如果您需要嵌入其他托管服务的视频,请使用以下格式:
@[](https://files.kpm-ritm.ru/Engee_firststeps.mp4)
HTML 整合
Markdown Engee 支持使用标签进行基于文本的 HTML 标记。让我们来看看最常用的标记:
带有 HTML 标记的_Markdown_。
-
<strong>
或<b>
- 标记用于将文本加粗。<strong>
最好用于语义相关的情况,即文本确实重要。<p>这段文字使用<strong>strong标签</strong>突出显示,而这段使用<b>b标签</b>突出显示。</p>
-
<em>
或<i>
- 标记用于斜体文本。与粗体标签一样,<em>
在语义相关的情况下更受欢迎。<p>这段文本使用<em>标签em</em>突出显示,而这段使用<i>标签i</i>。</p>
-
<s>
- 标记用于为文本添加删除线。<p>此文本 <s>已删除</s>。</p>
-
<p>
- 标记用于创建一段文字。段落通常上下缩进。<p>此文本位于段落中。</p>
-
<h1> -<h6>
- 标记用于创建不同级别的标题。标题有不同的大小,通常用于组织页面内容。<h1>一级标题</h1> <h2>二级标题</h2> <h3>三级标题</h3> <h4>四级标题</h4> <h5>五级标题</h5> <h6>六级标题</h6>
-
<ul>
,<ol>
,<li>
- 标记用于创建无序<ul>
和有序<ol>
列表及其元素<li>
。<ul> <li>无序列表的第一个元素</li> <li>无序列表的第二个元素</li> </ul> <ol> <li>有序列表的第一个元素</li> <li>有序列表的第二个元素</li> </ol>
-
<img>
- 标签用于在页面中插入图片。<img src="https://astralinux.ru/upload/iblock/ef6/398hnxlwiur3hci7uozjn9n9wagwp1n6.png" alt="标志 Engee">
-
<a>
- 标签用于插入链接。<a href="https://engee.com/helpcenter/stable/">Engee文档</a>