npm 包 bisheng-x 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

简介

Bisheng-x 是一个基于 Bisheng 的轻量化 React 静态网站生成器。它适合于搭建个人博客、技术文档以及小型网站。本文将介绍 Bisheng-x 的使用方法,并结合示例代码进行详细的解释。

安装

你可以使用 npm 或 yarn 进行安装:

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

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

创建项目

使用 Bisheng-x 创建一个新项目非常简单。你可以通过 bisheng-x init [projectName] 命令来进行初始化。其中,projectName 是你的项目名称。在执行该命令后,命令行界面将出现向导式的操作,你只需要按照提示进行操作即可。

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

配置

在项目的根目录中,可以找到一个名为 bisheng.config.js 的文件。该文件是 Bisheng-x 的配置文件,用于配置项目所需要的参数。下面是一个简单的示例:

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

-------------- - -
    ------- ----------
    ------- ---------
    ------ ----------
    -------- -
        ----------------------
    --
--
  • source: 项目源代码的目录。默认值是 ./posts
  • output: 项目的输出目录。默认值是 ./dist
  • theme: 项目的主题目录。默认值是 ./theme
  • plugins: 插件列表。默认值是 []

写文章

在项目的 source 目录中,你可以添加 Markdown 格式的文章。该文件夹下的结构将被保持不变。例如,倘若有如下目录结构:

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

在生成你的网站时,网址为 http://localhost:8000/ 的首页将直接渲染 source/index.md 这个文件,网址为 http://localhost:8000/about 将渲染 source/about.md,网址为 http://localhost:8000/posts/how-to-use-bisheng-x 将渲染 source/posts/how-to-use-bisheng-x.md

使用插件

Bisheng-x 支持自定义插件。你只需要在配置文件中的 plugins 字段添加你需要的插件即可。下面将介绍一个常用的插件。

Ant Design 插件

Ant Design 插件会自动引入所需的样式和脚本。要使用它,你需要在配置文件中的 plugins 字段添加 'bisheng-plugin-antd'

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

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

在你的文章中,你可以使用 Ant Design 中的组件。例如:

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

- ------

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

在渲染页面时,Bisheng-x 将自动引入 Ant Design 的样式和脚本文件。渲染后的页面如下所示:

运行

在配置文件设置完成后,你可以使用 bisheng-x start 命令来启动 Bisheng-x。该命令将启动一个本地服务器,你可以在浏览器中通过网址 http://localhost:8000 访问你的网站。

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

构建

使用 bisheng-x build 命令可以将网站构建到 output 目录中。

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

总结

Bisheng-x 是一个轻量化的 React 静态网站生成器。它非常适合搭建个人博客、技术文档以及小型网站。希望本文对你有所帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60055b8e81e8991b448d9350


猜你喜欢

  • npm 包 Inferno-menu-bar 使用教程

    随着前端开发的不断发展,我们使用的各种库和框架也越来越丰富,这些工具能够帮助我们更加高效地完成开发任务。而其中一个必不可少的工具就是 npm 包管理工具,今天我们将介绍一个名为 Inferno-men...

    2 年前
  • npm 包 @fpoumian/number-formatter 使用教程

    前言 随着 Web 技术的不断发展,前端开发变得越来越复杂和繁琐。而使用 npm 包可以大大简化前端开发中的许多问题。本文将介绍 npm 包 @fpoumian/number-formatter 的使...

    2 年前
  • npm 包 homebridge-haierplugin 使用教程

    前言 作为一名前端开发人员,在实际工作中常常需要和其他系统集成,而这些系统往往又有不同的接口和协议,这时就需要借助一些第三方库来解决这个问题。其中,npm 就是一个非常方便的包管理器,它为我们提供了大...

    2 年前
  • npm 包 nodepsd 使用教程

    简介 在前端开发中,我们常常需要对一些 PSD(Photoshop Document)文件进行切图或者提取其中的文字、颜色等信息。而 nodepsd 就是一个可以让我们直接通过代码来操作 PSD 文件...

    2 年前
  • npm 包 @khanghoang/react-native-mock 使用教程

    在 React Native 开发过程中,经常需要进行测试,但是测试真实设备上的应用需要花费大量时间和精力。因此,我们可以使用 mock 来进行开发和测试。 在本文中,我们将介绍一种使用 @khang...

    2 年前
  • npm 包 cordova-plugin-admob-unityads 使用教程

    介绍 cordova-plugin-admob-unityads 是一款基于 Cordova 技术的插件,用于在移动应用程序中集成 AdMob 和 UnityAds 广告。

    2 年前
  • npm 包 koa-react-middleware 使用教程

    在前端开发中,使用 React 构建单页面应用早已是常态。而在服务端开发中,使用 Node.js 开发 Web 应用也已经成为主流。因此,将 React 作为服务端渲染模板引擎使用的需求也愈发显著。

    2 年前
  • npm 包 embedb 使用教程

    介绍 embedb 是一个简单易用的 npm 包,用于在前端页面中嵌入数据库功能。嵌入式数据库是一种运行在应用程序内部的数据库,与常规的数据库不同,它不需要额外的服务器或进程。

    2 年前
  • npm 包 json-redactor 使用教程

    在前端开发中,操作 JSON 数据是一项必不可少的技能。然而在进行 JSON 数据处理时,我们经常会遇到繁琐的格式化和编辑问题。这时,npm 包 json-redactor 就成为了一款非常实用的工具...

    2 年前
  • npm 包 rocket-admin-theme 使用教程

    在现代的 Web 开发中,前端技术已经越来越重要。而 npm 作为一个包管理工具,为前端开发者提供了很多方便的工具和库。今天,我们来介绍一个非常实用的 npm 包:rocket-admin-theme...

    2 年前
  • npm 包 fortuned-api-client 使用教程

    在前端开发领域里,我们经常需要访问各种不同的 API 来获取数据,用于渲染页面或提供交互体验。而 fortuned-api-client 便是一个非常方便易用的 npm 包,它能够帮助我们快速地访问 ...

    2 年前
  • npm 包 topolr-mock 使用教程

    在前端开发过程中,mock 数据是十分常见的需求。而 topolr-mock 这款 npm 包能够帮助我们快速构造出符合需求的 mock 数据。本文将详细介绍 topolr-mock 的使用方法,包括...

    2 年前
  • npm 包 diff-text 使用教程

    在前端开发中,我们常常需要对比两个文本或字符串之间的差异,并将这些差异以更直观的方式展示给用户。这时候,我们可以使用 npm 包 diff-text 来实现这个功能。

    2 年前
  • npm 包 ex-pipe 使用教程及其意义

    注:本文将以 JavaScript 为主要语言进行讲解 在前端开发中,我们经常需要将一些复杂的数据结构进行处理,这时候就需要用到管道(pipe)的方式,将不同的操作串联起来,以达到高效的数据处理和转换...

    2 年前
  • npm 包 minigram-reflect 使用教程

    前言 在前端开发过程中,我们有许多自己封装的代码或者实现的功能,在使用的时候会感到很麻烦,尤其是在项目语言、工具等发生变化的时候。为了方便这种情况下的代码复用和快速开发,npm 这个包管理系统应运而生...

    2 年前
  • npm包 moondust-util 使用教程

    在前端开发过程中,我们经常需要用到一些工具来提高开发效率。npm是Node.js的包管理器,它提供了丰富的第三方包,方便我们快速集成一些常用的功能。moondust-util是一个基于Node.js的...

    2 年前
  • npm 包 @virtuoworks/electron-sahara-template-vuejs 使用教程

    随着 Electron 技术的发展,Vue.js 也成为了前端界的热门技术之一。@virtuoworks/electron-sahara-template-vuejs 是一个 Electron 的 V...

    2 年前
  • npm 包 karma-coffee2-preprocessor 使用教程

    在前端开发中,我们需要使用各种工具和技术来提高我们的开发效率和代码质量。其中,karma 和 coffee2-preprocessor 是一对非常有用的 npm 包,它们可以帮助我们在测试前端代码时,...

    2 年前
  • npm 包 imobile_for_javascript 使用教程

    简介 iMobile for Javascript 是一款面向移动设备的 JavaScript 交互开发库,提供了大量的地图功能和创建交互式地图应用所需的 API,非常适合前端开发人员使用,由 Sup...

    2 年前
  • npm 包 loadbar 使用教程

    概述 loadbar 是一个可以显示进度条的 npm 包,用于提升用户等待过程中的用户体验。它可以在前端页面中方便地引入,使用简单方便,且拓展性很强。 安装 在使用 loadbar 之前,需要先进行安...

    2 年前

相关推荐

    暂无文章