npm 包 metalsmith-classeur 使用教程

阅读时长 4 分钟读完

简介

metalsmith-classeur 是一个基于 Node.js 的静态网站生成工具,它可以将 Classeur 笔记转换成静态网页。Classeur 是一个在线 Markdown 编辑器,它支持多人协作,可以方便地创建、编辑和分享 Markdown 文档。metalsmith-classeur 可以把这些 Markdown 文档强大地导入到一个静态站点中。

安装

使用 npm 命令安装 metalsmith-classeur:

配置

在使用 metalsmith-classeur 之前,需要安装并配置 metalsmith。metalsmith 是一个基于 Node.js 的静态网站生成器,它可以方便地将 Markdown 文件转换成静态网页。

metalsmith-classeur 的配置非常简单,只需要在 metalsmith 的配置文件中添加一个 metalsmith-classeur 插件即可。

以下是一个示例配置文件:

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

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

在这个配置中,

  • source 指定了源文件路径;
  • destination 指定了生成文件的目标路径;
  • markdown 是用来将 Markdown 文件转为 HTML 的插件;
  • classeur 是 metalsmith-classeur 插件;
  • accessToken 是你在 Classeur 上的访问令牌;
  • documentId 是你想要导入的 Classeur 笔记的 ID;
  • pathPrefix 是你想要导入的笔记在生成站点中的路径。

使用

配置好后,运行以下命令来生成你的站点:

然后在生成的路径中找到 index.html 文件,它就是你导入的 Classeur 笔记了。

示例

以下是一个示例配置文件,它导入 ID 为 your-document-id 的笔记,并将其放在生成站点的 /notes 路径下:

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

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

在生成的站点中,你可以访问 /notes/index.html 来查看你导入的笔记。

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

纠错
反馈