npm 包 bisheng-plugin-antd 使用教程

简介

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 文件,并在文件头部添加如下格式的参数:

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

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

其中 titlesubtitle 为可选参数。

2.启动命令

在终端中输入以下命令启动 bisheng:

--- --- -----

3.在 Dashboard 中查看页面

在浏览器中打开 http://localhost:8000/ 即可看到 Dashboard,展示了当前所有的 Markdown 文件和相应的 Ant Design 样式。

示例代码

bisheng-plugin-antd 的示例代码如下:

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

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

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

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

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

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

Markdown 文件示例:

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

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

--- -------

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

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

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

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

猜你喜欢

  • npm 包 entcore-toolkit 使用教程

    介绍 entcore-toolkit 是一个用于前端开发的 npm 包,它提供了许多实用的工具函数,可以帮助开发者快速开发高质量的前端应用。其中包括通用工具类函数、表单验证、国际化、字符串处理以及日期...

    5 年前
  • npm 包 gulp-append-prepend 使用教程

    在前端开发中,使用构建工具可以提高开发效率,其中 Gulp 是一款广受欢迎的构建工具。在使用 Gulp 进行项目开发时,经常需要在某些文件的开头或结尾添加一些特定内容,比如版权信息、声明等。

    5 年前
  • npm 包 gulp-buble 使用教程

    前端开发经常会用到工具来提高开发效率,其中构建工具是必不可少的一部分。gulp 是常用的构建工具之一,而 gulp-buble 这个 npm 包则可以帮助我们将 ES6/ES7 的代码转化为 ES5 ...

    5 年前
  • npm 包 `wdio-browserstack-service`使用教程

    什么是wdio-browserstack-service? wdio-browserstack-service是一个Node.js包,它提供了与Browserstack集成的WebdriverIO S...

    5 年前
  • npm 包 karma-typescript 使用教程

    1. 前言 在前端开发中,编写 TypeScript 是大势所趋,而 karma-typescript 是一款高效的 TypeScript 单元测试工具。本文将介绍如何使用 karma-typescr...

    5 年前
  • npm 包 entcore 使用教程

    在前端开发中,使用 npm 作为包管理工具是非常常见的。在实际开发中,会用到许多第三方 npm 包,其中 entcore 是一个非常有用的 npm 包,它可以帮助开发人员方便地实现企业级应用的前端部分...

    5 年前
  • npm 包 d3-selection-multi 使用教程

    简介 d3-selection-multi 是一个npm包,它扩展了D3.js的选择集,允许你可以用一种更加灵活、简化的方式操作HTML和SVG属性。在这个教程中,我们将介绍如何使用d3-select...

    5 年前
  • npm 包 rollup-plugin-ascii 使用教程

    在现代的前端开发中,我们经常使用到 npm 包管理器来加速开发并重用代码,在很多情况下也需要用到工具来帮助我们进行依赖管理和构建。其中 rollup 是一个非常优秀的打包工具,可以将多个 js 模块打...

    5 年前
  • npm 包 d3-v4-bundler 使用教程

    简介 d3-v4-bundler 是一个 npm 包,是基于 D3.js 库的一种封装。D3.js 是一个数据可视化库,它允许 JavaScript 开发者通过数据驱动方式进行可视化操作。

    5 年前
  • npm 包 marklet 使用教程

    在前端开发过程中,我们经常会使用书签(bookmarklet)来快速访问一些常用功能或调试工具。但是书签需要手工编写,容易出错,且不方便分享和更新。为了解决这个问题,有人开发了一个叫做 marklet...

    5 年前
  • npm 包 npm-squatting-check 的使用教程

    前言 在开发过程中,为了方便代码管理和使用,我们经常会使用各种 npm 包,但是如果不注意,有些 npm 包可能会是恶意的、与正常的 npm 包同名的“蹭热度”包或者拼写相似的包,这些包可能会包含恶意...

    5 年前
  • npm包point-in-svg-polygon使用教程

    简介 point-in-svg-polygon 是一个npm包,用于计算一个点是否在SVG多边形中。这个包专门针对SVG图形,并且支持比较复杂的SVG多边形。 在前端领域,有时需要对SVG图像的元素进...

    5 年前
  • npm 包 rollup-plugin-prettyuglify 使用教程

    在前端开发中,我们经常需要使用打包工具来将多个文件打包成一个文件。而 rollup 是一款非常优秀的打包工具,常常被用于构建大小和性能都有较高要求的应用。 而 rollup-plugin-pretty...

    5 年前
  • npm 包 swig-marked 使用教程

    在前端开发中,我们经常需要使用到 Markdown 格式的文本。而 swig-marked 是一个能够将 Markdown 转换成 HTML 的 npm 包,使用非常方便。

    5 年前
  • npm 包 ppo 使用教程

    什么是 ppo? ppo 是一款用于前端开发的 npm 包,它提供了易于使用的 css 和 js 功能,包括 媒体查询、flex 布局等等的快速开发功能。 安装 ppo --- ------- ---...

    5 年前
  • npm 包 ms-react-native 使用教程

    在开发 React Native 应用程序时,常常需要根据时间长度来格式化时间。在这种情况下,我们可以使用 ms-react-native 这个 npm 包来完成这个任务。

    5 年前
  • npm 包 rocket-bundler 使用教程

    简介 rocket-bundler 是一个开源的 JavaScript 模块打包器,它可以将多个模块打包成一个文件并处理资源依赖关系。它具有自动化打包、CDN 集成等功能,是前端开发中不可或缺的工具之...

    5 年前
  • npm 包 grunt-html-imgbase64 使用教程

    简介: grunt-html-imgbase64 是一款基于 Node.js 平台的 npm 包,可以帮助前端开发者将项目中的 HTML 中的图片文件转化为 base64 编码,进而减少 HTTP 请...

    5 年前
  • npm 包 react-native-aws-iot-device-shadows 使用教程

    在前端开发中,使用第三方库和包是非常常见的。而在使用 AWS 云服务时,react-native-aws-iot-device-shadows 是一个非常实用的 npm 包。

    5 年前
  • npm 包 ejs-mde-loader 使用教程

    在前端开发中,我们常常需要使用模板引擎来渲染网页。其中 EJS 是一种常用的模板引擎。而 ejs-mde-loader 则可以让我们更方便地在 Vue 项目中使用 EJS 模板。

    5 年前

相关推荐

    暂无文章