将脚本标签添加到 markdown 文件

Question

我正在 MKdocs 中开发文档，需要将一些脚本文件加载到我的 markdown 文件中。如何在markdown中添加js函数和脚本标签？

Answer 1

您有两个选择：您可以在 Markdown 中包含原始 HTML<script>标签，或者您可以使用 MkDocsextra_javascript设置来指向您自己的 JavaScript 文件。

\n\n

使用原始 HTML

\n\n

正如 Markdown 文档所解释的：

\n\n

\n

对于 Markdown\xe2\x80\x99s 语法未涵盖的任何标记，您只需\n 使用 HTML 本身。\xe2\x80\x99s 不需要加前缀或定界来\n 表明你\xe2\x80\x99 正在从 Markdown 切换到 HTML；您只需使用 \n 标签即可。

\n\n

唯一的限制是块级 HTML 元素\xe2\x80\x89\xe2\x80\x94\xe2\x80\x89e.g.\n <div>、<table>、<pre>、<p>等\xe2\x80\x89\xe2\x80\ x94\xe2\x80\x89 必须用空行与周围的内容分隔，并且块的开始和结束标记不应使用制表符或空格缩进。

\n

\n\n

当然，任何此类脚本对于它们所包含的一页来说都是唯一的。

\n\n

使用extra_javascript

\n\n

如果您希望脚本在所有页面上可用，MkDocs 提供了extra_javascript配置设置，这将导致script每个页面上都包含指向指定文件的 。只需确保该文件在您的docs_dir.

\n\n

例如，如果您创建一个文件myscript.js，则将以下内容添加到您的mkdocs.yml配置文件中：

\n\n

extra_javascript:\n    myscript.js\n

\n