跳到主要内容

通过我们的文档构建脚本和测试帮助开发 Bootstrap。

工具设置

Bootstrap 使用 npm 脚本 来构建文档和编译源文件。我们的 package.json 包含这些用于编译代码、运行测试等的脚本。这些并非用于我们仓库和文档之外的用途。

要使用我们的构建系统并在本地运行我们的文档,你需要一份 Bootstrap 的源文件和 Node。按照以下步骤操作,你就可以准备就绪:

  1. 下载并安装 Node.js,我们用它来管理依赖项。
  2. 要么 下载 Bootstrap 的源码,要么 fork 并克隆 Bootstrap 的仓库。
  3. 导航到根目录 /bootstrap 并运行 npm install 来安装 package.json 中列出的本地依赖项。

完成后,你将能够从命令行运行提供的各种命令。

使用 npm 脚本

我们的 package.json 包含了许多用于开发项目的任务。在终端运行 npm run 以查看所有 npm 脚本。主要任务包括:

任务描述
npm start编译 CSS 和 JavaScript,构建文档,并启动本地服务器。
npm run dist创建包含已编译文件的 dist/ 目录。使用 Sass、Autoprefixer 和 terser。
npm test在运行 npm run dist 后本地运行测试。
npm run docs-serve本地构建并运行文档。

通过我们的入门项目使用 npm 开始使用 Bootstrap! 前往 Sass & JS 示例 模板仓库,看看如何在你自己的 npm 项目中构建和自定义 Bootstrap。包括 Sass 编译器、Autoprefixer、Stylelint、PurgeCSS 和 Bootstrap 图标。

Sass

Bootstrap 使用 Dart Sass 将我们的 Sass 源文件编译为 CSS 文件(包含在我们的构建过程中),我们建议如果你使用自己的资源管道编译 Sass,也采用同样的方法。我们之前在 Bootstrap v4 中使用 Node Sass,但 LibSass 及其上构建的包,包括 Node Sass,现在已经 不推荐使用。

Dart Sass 使用 10 位的舍入精度,并且出于效率原因不允许调整该值。在对我们生成的 CSS 进行进一步处理(例如压缩)时,我们不会降低此精度,但如果你选择这样做,我们建议保持至少 6 位精度,以防止浏览器舍入问题。

Autoprefixer

Bootstrap 使用 Autoprefixer(包含在我们的构建过程中)在构建时自动为某些 CSS 属性添加供应商前缀。这样做可以节省我们的时间和代码,因为我们只需编写一次 CSS 的关键部分,同时无需使用像 v3 中那样的供应商 mixin。

我们通过 Autoprefixer 维护支持浏览器的列表,该列表存放在我们 GitHub 仓库中的一个单独文件中。详情请参见 .browserslistrc。

RTLCSS

Bootstrap 使用 RTLCSS 来处理编译后的 CSS 并将其转换为 RTL——基本上是将水平方向相关的属性(例如 padding-left)替换为相反的属性。它允许我们只编写一次 CSS,并使用 RTLCSS 的 控制 和 值 指令进行小的调整。

本地文档

在本地运行我们的文档需要使用 Astro。Astro 是一个现代的静态网站生成器,允许我们使用 Markdown 和 React 组件的组合来构建文档。以下是入门方法:

  1. 按照上面的工具设置安装所有依赖项。
  2. 在根/bootstrap目录下,在命令行中运行npm run docs-serve。
  3. 在浏览器中打开http://localhost:9001,就大功告成了。

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

故障排除

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