npm 是 node.js 里广为使用的包管理器，它可以帮助我们更好地管理我们项目中的依赖，也可以让我们快速安装和使用模块。
而其中的 within-document 这个 npm 包就是一个非常实用的工具，它可以让我们在文档页面中嵌入代码并展示出来，非常适用于写技术博客或者文档类的网页。
What is within-document?
within-document 是一个可以将代码嵌入到文档页面中并实时运行的 npm 包，它是建立在 paredit 和 CodeMirror 这两个 JavaScript 库之上的。它支持多种代码类型的展示，包括 HTML、JavaScript、CSS 和其他前端技术。它还支持 EvalJS 插件，此插件可以帮助我们在展示代码之后做一些交互式操作，非常实用。
Installation
在使用 within-document 之前，我们需要先安装它。
你可以在终端窗口中输入以下命令进行安装：
npm install within-document --save
安装完成后，我们就可以在代码中引入 within-document 了。
Usage
在使用 within-document 前，我们需要先引入它。你可以在你的代码中使用以下命令：
import withinDocument from 'within-document';
安装完成后，我们可以开始在文档页面中嵌入代码了。
- 首先，我们需要给需要嵌入代码的片段添加 class 名称，这个名称可以是任意的字符串，在实际使用中最好使用有意义的名称。
<p class="embed">This is the code to be embedded</p>
- 然后，在 JavaScript 中指定 class 名称，配置 within-document，并将代码嵌入到文档的特定区域中。如以下代码：
-- -------------------- ---- -------
--- ---- - -
---------- -
------- -----
-
--
--- --- - ------------------------------------------
------------------------ --- --------- ------- --------- -------- ---- -- -------- ---------- -
--- ---- - ----------------------
------------- - -----
---在代码中，我们传递 options 参数，它包含一个属性 evaluator，示例中这个属性的值为 evalJS: true，这意味着我们将启用 EvalJS 插件。最后调用 process 函数将代码嵌入到特定区域中。
Tips
- 允许执行解构的修改。
- 若参数 value 属性内包含 wrap 属性（可能为 DomString、DomNode 或 function），则该 wrap 属性会被调用进行包裹。
Conclusion
以上就是 within-document 的使用教程，它可以让我们方便地将代码嵌入到文档页面，非常实用。在使用时，我们需要注意一些细节，例如为要嵌入代码的片段添加 class 名称，并在 JavaScript 中指定 class 名称等。希望本文对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/75158