View on GitHub

构建工具

了解如何使用 Bootstrap Table 包含的 npm 脚本来构建文档、编译源代码等。

工具设置

Bootstrap Table 使用 NPM 脚本作为其构建系统。我们的 package.json 包含了处理框架的便捷方法，包括代码检查、代码编译等。

要使用我们的构建系统并在本地运行文档，您需要 Bootstrap Table 的源文件和 Node。按照以下步骤，您应该就可以开始了：

  1. 下载并安装 Node.js，我们用它来管理依赖。
  2. 导航到根目录 /bootstrap-table 并运行 npm install，安装 package.json 中列出的本地依赖。
  3. 安装 Ruby，使用 gem install bundler 安装 Bundler，最后运行 bundle install。它将安装所有 Ruby 依赖，如 Jekyll 和插件。
    • Windows 用户： 阅读 此指南，以无问题地启动 Jekyll。

完成后，您将能够从命令行运行各种命令。

使用 NPM 脚本

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

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

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

本地文档

在本地运行我们的文档需要使用 Jekyll，这是一个相当灵活的静态站点生成器，为我们提供了：基本包含、基于 Markdown 的文件、模板等。以下是启动步骤：

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

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

故障排除

如果遇到安装依赖的问题，请卸载所有先前的依赖版本（全局和本地）。然后重新运行 npm install。