在 GitHub 上查看

构建工具

了解如何使用 Bootstrap 表格的内置 npm 脚本构建我们的文档,编译源代码等等。

工具设置

Bootstrap 表格使用 NPM 脚本 作为其构建系统。我们的 package.json 包含方便的方法用于处理框架,包括代码 linting、代码编译等等。

要使用我们的构建系统并在本地运行我们的文档,你需要一份 Bootstrap 表格源文件和 Node 的副本。按照以下步骤操作,你就可以开始使用了

  1. 下载并安装 Node.js,我们使用它来管理我们的依赖项。
  2. 导航到根目录 /bootstrap-table 并运行 npm install 来安装我们列在 package.json 中的本地依赖项。
  3. 安装 Ruby,使用 gem install bundler 安装 Bundler,最后运行 bundle install。它将安装所有 Ruby 依赖项,例如 Jekyll 和插件。
    • Windows 用户:请阅读 本指南,以了解如何在 Windows 上无障碍地运行 Jekyll。

完成后,你就可以从命令行运行提供的各种命令。

使用 NPM 脚本

我们的 package.json 包含以下命令和任务

任务 描述
npm run build npm run build 创建包含已编译文件的 /dist 目录。
npm run lint /src 目录的 CSS 和 JavaScript 进行 linting。
npm run docs 构建并 linting 文档的 CSS 和 JavaScript。然后,你可以通过 npm run docs-serve 在本地运行文档。

运行 npm run 以查看所有 npm 脚本。

本地文档

在本地运行我们的文档需要使用 Jekyll,这是一种相当灵活的静态网站生成器,它为我们提供了:基本包含、基于 Markdown 的文件、模板等等。以下是如何开始使用它

  1. 按照上面的 工具设置 步骤安装 Jekyll(网站构建器)和其他 Ruby 依赖项,使用 bundle install
  2. 从根目录 /bootstrap-table,在命令行中运行 npm run docs-serve
  3. 在你的浏览器中打开 http://localhost:9001,大功告成。

阅读 Jekyll 的 文档 了解更多关于使用 Jekyll 的信息。

故障排除

如果你在安装依赖项时遇到问题,请卸载所有以前的依赖项版本(全局和本地)。然后,重新运行 npm install