我正在 MKdocs 中开发文档,需要将一些脚本文件加载到我的 markdown 文件中。如何在markdown中添加js函数和脚本标签?
问问题
7460 次
1 回答
4
你有两个选择:你可以在你的 Markdown 中包含原始的 HTML<script>
标签,或者你可以使用 MkDocs 的extra_javascript
设置来指向你自己的 JavaScript 文件。
使用原始 HTML
正如 Markdown 文档所解释的:
对于 Markdown 语法未涵盖的任何标记,您只需使用 HTML 本身。无需为它加上前缀或定界以表明您正在从 Markdown 切换到 HTML;您只需使用标签。
唯一的限制是块级 HTML 元素(例如
<div>
、<table>
、<pre>
、<p>
等)必须用空行与周围的内容隔开,并且块的开始和结束标记不应使用制表符或空格缩进。
当然,任何此类脚本对于包含它们的一页都是唯一的。
利用extra_javascript
如果您希望脚本在所有页面上可用,MkDocs 提供了extra_javascript配置设置,这将导致script
指向指定文件的 a which 包含在每个页面上。只需确保该文件在您的docs_dir
.
例如,如果您创建一个文件myscript.js
,则将以下内容添加到您的mkdocs.yml
配置文件中:
extra_javascript:
myscript.js
于 2019-09-23T17:09:39.073 回答