npm 包 spitup 使用教程

阅读时长 3 分钟读完

简介

Spitup 是一个强大的前端静态网页生成器,使用 markdown 语言和特有的 spitup 格式,可以生成漂亮、干净、高度可定制化的静态网页。其最大的特点是完全基于由用户提交的 markdown 文件动态生成 HTML 文件,十分适合于个人博客、技术文档等场景。spitup 是基于 npm 包,轻量、快速、易于使用,已经成为前端开发中不可或缺的工具。

安装

在终端窗口输入以下命令安装 spitup:

“-g”参数为全局安装,允许在任何地方运行 spitup 命令。

使用

创建项目

在终端中进入项目目录,使用以下命令创建项目:

执行后,会自动生成项目目录和默认的项目配置文件 spitup.config.js。

编写文章

在文章目录下创建 markdown 文件,按照 spitup 的 markdown 语法规范编写,如下:

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

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

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

---- ---- ---

-- --

在文章头部需要使用 "---" 包含的插件,定义 title 和 date,文章中间的 “” 标签用于在文章预览时截取 summary 部分。

构建网站

在项目目录下使用以下命令构建网站:

执行后,会在项目目录下生成 “dist” 目录,其中包含生成的静态网页。

本地预览

使用以下命令在本地服务器上预览网页:

执行后,在终端可看到服务器地址,打开浏览器输入该地址即可查看网页。

示例代码

思路清晰写得简洁的代码会使生成效果更出色。以下是一段示例代码,其他语法及使用方法详见官方文档。

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

- ------

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

-- ----

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

---- ---- ---

-- ------

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

------------------- -- -
    --------------- ------- ------
---
纠错
反馈