简介
npm 是 Node.js 的包管理器,使 JavaScript 开发人员能够轻松地共享和重用代码。其中 bisheng-plugin-antd 是一款基于 Ant Design 框架的 bisheng 插件。bisheng 是一个使用 Markdown编写文档和博客的工具,借助 bisheng-plugin-antd,用户可以在 Dashboard 中方便简单地管理和展示指定目录中的 Markdown 文档和相应的 Ant Design 样式。
本篇文章将详细讲解 bisheng-plugin-antd 的使用方法,包括如何安装、配置和使用。
安装
对于 bisheng-plugin-antd 的安装,只需要使用 npm 即可,命令如下:
--- ------- ------------------- ----------
配置
1.配置 bisheng.config.js
文件
在使用 bisheng-plugin-antd 之前,需要在项目目录下创建 bisheng.config.js
文件,用于配置 bisheng 的相关参数,如下:
-------------- - - -- --- -------- ------------------------ -- --- -
2.配置 config.js
文件
在 bisheng.config.js
文件中,需要指定 Ant Design 的主题和相关配置,这一步需要在项目目录下创建 config.js
文件,按照以下格式配置:
----- ---- - ---------------- -------------- - - ------ -------------------- ----- ----- ------- - ----------- --------------- -- ------- --------- ------------ - ----- ---- --------- ---- -------- - ---------- -------------------- ---------------------------- -------- - ---------------------- -- --
3.添加主题文件
在使用 bisheng-plugin-antd 时需要添加主题文件,即 theme.config.js
文件,按照以下格式配置:
----- ------------ - ---------- -------------- - - ---------------- ------------- --
并在 config.js
文件中配置 theme
参数为 ./theme.config.js
。
使用
1.创建文档页面
在指定目录下,创建以 .md
为后缀名的 Markdown 文件,并在文件头部添加如下格式的参数:
--- ------ ---- --------- ---- --- --------- ----------
其中 title
和 subtitle
为可选参数。
2.启动命令
在终端中输入以下命令启动 bisheng:
--- --- -----
3.在 Dashboard 中查看页面
在浏览器中打开 http://localhost:8000/
即可看到 Dashboard,展示了当前所有的 Markdown 文件和相应的 Ant Design 样式。
示例代码
bisheng-plugin-antd 的示例代码如下:
-- ----------------- -------------- - - ------- - ----------- --------------- -- ----- ----- ------ -------------------- ------- --------- ---------- -------------------- ---------------------------- -------- - ---------------------- -- ------------ - ----- ---- --------- ---- -------- -- -- -- --------- ----- ---- - ---------------- ----- ------------ - ---------- -------------- - - ----------- --------- ------- - ----------- ------------------- -- ------ -------------------- -------- - --------------------- -- ------------ - ----- ---- --------- ---- ------ ----- --------- --------------- -- -- -- --------------- ----- ------------ - ---------- -------------- - - ---------------- ------------- --
Markdown 文件示例:
--- ------ ------ --------- --------- -- --------- --- -------- --------- -- ---- -- --- --------- ------- -- -- ----------- --- ------- ------ ------ - ------ - ---- ------- ------- ---------------------- ---------------
-- -- --------- ------------------- ----------------------------------------------- ----------------------------- ----------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------