npm 包 strapdown-cli 使用教程

阅读时长 5 分钟读完

简介

strapdown-cli 是一款基于 Markdown 格式快速生成实时渲染的静态网页的 npm 包。strapdown-cli 提供了一种简便的方式,可以使用您喜欢的 Markdown 编辑器编写 Markdown 文档,并将其转换成带有实时渲染 Markdown 输出的 HTML 静态页面。本文将介绍如何使用 strapdown-cli 并提供示例代码。

安装

您可以通过 npm 安装 strapdown-cli,命令如下:

使用

使用 strapdown-cli 非常简单,只需要通过命令行将 Markdown 格式的文件转换为带有实时渲染 Markdown 输出的 HTML 静态页面即可。使用步骤如下:

步骤一:创建 Markdown 文件

首先,您需要创建一个 Markdown 文件,例如 hello.md

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

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

-- ---

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

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

列表

以下是一个无序列表:

  • Item 1
  • Item 2
  • Item 3

strapdown hello.md

strapdown hello.md -o /path/to/output/

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

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

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

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

步骤四:其他选项

strapdown-cli 还提供了其他选项,例如:

  • -h: 显示帮助信息。
  • -t [theme]: 指定主题,例如:-t united。默认主题为 united,可用的主题包括 united、cerulean、cosmo、cyborg、darkly、flatly、journal、lumen、paper、readable、sandstone、simplex、slate、spacelab、superhero、united 和 yeti。
  • -c: 指定使用自定义 CSS。

示例代码

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

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

-- ---

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

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

列表

以下是一个无序列表:

  • Item 1
  • Item 2
  • Item 3
-- -------------------- ---- -------
--------- -----
------
------
----- ----------------
-----------------------

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

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

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

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

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

-- ---

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

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

列表

以下是一个无序列表:

  • Item 1
  • Item 2
  • Item 3
-- -------------------- ---- -------

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

-- --

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

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