将脚本标签添加到markdown文件

Question

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

Answer 1

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

使用原始HTML

作为Markdown文档explains：

  

对于Markdown语法未涵盖的任何标记，您只需   使用HTML本身。无需在其前添加或定界为   表示您正在从Markdown切换为HTML；你只用   标签。

     

唯一的限制是块级HTML元素。   <div>，<table>，<pre>，<p>等。— ust必须与   用空行围住内容，以及   块不应使用制表符或空格缩进。

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

使用extra_javascript

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

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

extra_javascript:
    myscript.js