npm 包 Pagic 使用教程

阅读时长 5 分钟读完

Pagic 是一个基于 Markdown 文件的静态网站生成器,它可以帮助你快速搭建自己的个人博客或者静态网站。Pagic 支持自定义主题,编写自定义插件,使得用户可以自由地定制自己的博客或者网站。

本文将详细介绍 Pagic 的使用方法及其常用命令。

安装 Pagic

Pagic 是一个 npm 包,所以在安装之前需要先确保已经安装了 Node.js 和 npm。

打开命令行工具(Terminal 或者 Git Bash),输入以下命令进行安装:

安装成功后,可以使用以下命令检查版本是否正确:

如果显示出当前 Pagic 的版本号,则说明安装成功。

初始化 Pagic

安装成功之后,我们需要在工作目录下初始化一个 Pagic 项目。先打开命令行工具,将工作目录切换到合适的文件夹下(比如新建一个目录 pagic_demo),输入以下命令:

这个命令会生成一些初始文件和目录,并自动安装必要的依赖包。初始化成功后,可以看到以下文件和目录:

  • docs: 存放 Markdown 文件的目录,这里默认只有一个 README.md 文件。
  • pagic.config.ts: Pagic 的配置文件,用于定义主题,插件、网站标题、作者等内容。
  • package.json: Node.js 的配置文件,里面包含了 Pagic 的依赖包等信息。

现在我们来尝试一下把这个项目跑起来。在命令行中输入以下命令:

这个命令会把 docs 目录中的 Markdown 文件转换成 HTML,并生成静态文件,生成成功后,可以在项目根目录下看到 dist 文件夹,它里面包含了生成的 HTML 文件。

现在我们可以打开浏览器,输入 dist/index.html 地址,就可以看到我们的网站啦。

自定义主题

Pagic 的主题支持自定义,你可以根据自己的需求来修改默认主题,也可以自己编写新的主题。在 pagic.config.ts 文件中设定主题。

Pagic 官方提供了一些可用的主题模板,你可以通过以下命令来安装相应的模板:

此命令会列出所有可用的主题模板,输入 1 确认安装。

安装成功后,你可以在 pagic.config.ts 文件中找到 theme 属性,将其设为 onedark,这个属性就是用来设置主题的。

现在你可以运行 pagic build,重新生成网站,你会发现网站的样式已经改变了。

自定义插件

Pagic 支持编写自定义插件,使得用户可以根据自己的需求来扩展 Pagic 的功能。

比如我们需要一款自动生成目录的插件,为此,我们可以新建一个 plugins 文件夹,然后在文件夹中新建一个 catalog.ts 文件,用来定义我们的插件。

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

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

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

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

这个插件会在 Markdown 渲染的过程中,自动将网页上所有的标题自动引用生成一个目录。现在我们需要在 Pagic 的配置文件 pagic.config.ts 中加载这个插件。

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

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

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

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

这个时候重新运行 pagic build,就会自动在网页上生成一个目录了。

总结

在本篇文章中,我们详细讲解了如何使用 Pagic 创建静态网站。涉及到的内容包括:安装 Pagic、初始化项目、自定义主题、自定义插件。

Pagic 可以很好地应用在个人博客、小型团队网站等场景。其简单易用、扩展性强的特点,为用户提供了很好的使用体验。如果你有相关的需求,可以尝试使用 Pagic 进行开发。

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

纠错
反馈