npm 包 metalsmith-wikiwords 使用教程

阅读时长 3 分钟读完

在前端开发中,使用模板引擎来渲染 HTML 是一个常见的任务。metalsmith-wikiwords 是一个用于生成静态网站的静态站点生成器的中间件,使用了简单直观的 wikiwords 语法。在这篇文章中,我们将介绍如何使用 metalsmith-wikiwords。

什么是 metalsmith-wikiwords?

metalsmith-wikiwords 是一个生成静态网站的基于 Middlewares 的工具。与其他静态网站生成器不同,metalsmith-wikiwords 使用了简单直观的 wikiwords 语法,允许您使用类似简单的 wikiwords 语法来编写您的文章。

安装 metalsmith-wikiwords

前提条件:已经安装了 Node 和 npm。

打开终端并输入以下命令来安装 metalsmith-wikiwords:

如何使用 metalsmith-wikiwords?

metalsmith-wikiwords 将 wikiwords 语法转换为类似于 Markdown 的标记语言。例如,输入 [[Hello World]] 将会生成一个链接到 "Hello World" 页面的链接。

下面是一些示例代码:

-- -------------------- ---- -------
----- ---------- - ----------------------
----- -------- - -------------------------------
----- --------- - --------------------------------

---------------------
    ---------------- -- ------
    ---------------------- -- -----
    ----------------
    -----------------
    --------------- ----- -
        -- ----- ----- ----
    ---

在上面的代码中,我们首先将 markdown 中间件用于将 Markdown 文件转换为 HTML 文件,然后使用 wikiwords 中间件将 wikiwords 语法转换为 HTML。

使用示例

现在,我们来看一下如何使用 wikiwords 语法。

创建新页面

要创建新页面,你只需要在文本文件中按照以下格式添加 wikiwords 标记:

这样,您就可以使用 wikiwords 语法来链接到这个页面了:

使用命名空间

如果您有多个重复命名的页面,您可以将它们放在不同的命名空间中。要将页面放入特定的命名空间中,请在文件名称后加上双冒号 "::",并使用完整的命名空间名称:

现在,你可以使用以下形式的 URL 来访问这个页面:

要正常显示 wikiwords 标记之前,您必须启用 middleware,如上面的例子所示:

结论

在本文中,我们介绍了一个称为 metalsmith-wikiwords 的 npm 包,并展示了如何使用它来完成用简单直观的 wikiwords 语法生成 HTML 文件。这对于创建静态网站来说是很有用的。我们鼓励读者亲自尝试,以便更深入地了解它的用法。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066f421d8e776d08040e15

纠错
反馈