查看“Docsify 文档助手”的源代码

docsify 扩展了一些 Markdown 语法，可以让文档更易读。

== 强调内容 ==

适合显示重要的提示信息，语法为 <code>!&gt; 内容</code>。

<pre class="markdown">!&gt; 一段重要的内容，可以和其他 **Markdown** 语法混用。</pre>


== 普通提示 ==

普通的提示信息，比如写 TODO 或者参考内容等。

<pre class="markdown">?&gt; _TODO_ 完善示例</pre>


== 忽略编译链接 ==

有时候我们会把其他一些相对路径放到链接上，你必须告诉 docsify 你不需要编译这个链接。 例如：

<pre class="md">[link](/demo/)</pre>
它将被编译为 <code>&lt;a href=&quot;/#/demo/&quot;&gt;link&lt;/a&gt;</code> 并将加载 <code>/demo/README.md</code>. 可能你想跳转到 <code>/demo/index.html</code>。

现在你可以做到这一点

<pre class="md">[link](/demo/ ':ignore')</pre>
即将会得到 <code>&lt;a href=&quot;/demo/&quot;&gt;link&lt;/a&gt;</code> html 代码。不要担心，你仍然可以为链接设置标题。

<pre class="md">[link](/demo/ ':ignore title')

&lt;a href=&quot;/demo/&quot; title=&quot;title&quot;&gt;link&lt;/a&gt;</pre>
<span id="设置链接的-target-属性"></span>
== 设置链接的 target 属性 ==

<pre class="md">[link](/demo ':target=_blank')

== 禁用链接 ==

<pre class="md">[link](/demo ':disabled')</pre>
== 跨域链接 ==

只有当你同时设置了 <code>routerMode: 'history'</code> 和 <code>externalLinkTarget: '_self'</code> 时，你需要为这些跨域链接添加这个配置。

<pre class="md">[example.com](https://example.com/ ':crossorgin')</pre>
<span id="github-任务列表"></span>
== Github 任务列表 ==

<pre class="md">- [ ] foo
- bar
- [x] baz
- [] bam &lt;~ not working
  - [ ] bim
  - [ ] lim</pre>


== 图片处理 ==

=== 缩放 ===

<pre class="md">![logo](https://docsify.js.org/_media/icon.svg ':size=WIDTHxHEIGHT')
![logo](https://docsify.js.org/_media/icon.svg ':size=50x100')
![logo](https://docsify.js.org/_media/icon.svg ':size=100')

&lt;!-- 支持按百分比缩放 --&gt;

![logo](https://docsify.js.org/_media/icon.svg ':size=10%')</pre>


<span id="设置图片的-class"></span>
=== 设置图片的 Class ===

<pre class="md">![logo](https://docsify.js.org/_media/icon.svg ':class=someCssClass')</pre>
<span id="设置图片的-id"></span>
=== 设置图片的 ID ===

<pre class="md">![logo](https://docsify.js.org/_media/icon.svg ':id=someCssId')</pre>
<span id="设置标题的-id-属性"></span>
== 设置标题的 id 属性 ==

<pre class="md">### 你好，世界！ :id=hello-world</pre>
<span id="html-标签中的-markdown"></span>
== html 标签中的 Markdown ==

你需要在 html 和 Markdown 内容中插入空行。 当你需要在 details 元素中渲染 Markdown 时很有用。

<pre class="markdown">&lt;details&gt;
&lt;summary&gt;自我评价（点击展开）&lt;/summary&gt;

- Abc
- Abc

&lt;/details&gt;</pre>


Markdown 内容也可以被 html 标签包裹。

<pre class="markdown">&lt;div style='color: red'&gt;

- listitem
- listitem
- listitem

&lt;/div&gt;</pre>