使用我们的文档构建脚本和测试帮助开发 Bootstrap。
工具安装
Bootstrap 使用 npm scripts来构建文档和编译源文件。我们的 package.json包含这些脚本,用于编译代码、运行测试等。这些脚本不能在我们的版本库和文档之外使用。
要使用我们的构建系统并在本地运行我们的文档,您需要 Bootstrap 源文件和 Node 副本。按照以下步骤操作,您就可以大展身手了:
- 下载并安装 Node.js,我们用它来管理依赖关系。
- 下载 Bootstrap 的源代码或 fork 和克隆Bootstrap 的仓库。
- 导航至根目录
/bootstrap
,运行npm install
安装 package.json 中列出的本地依赖项。
完成后,您就可以从命令行运行所提供的各种命令。
使用 npm 脚本
我们的 package.json包含大量用于开发项目的任务。运行 npm run
可在终端中查看所有 npm 脚本。主要任务包括:
Task | Description |
---|---|
npm start |
编译 CSS 和 JavaScript、构建文档并启动本地服务器。 |
npm run dist |
创建包含编译文件的 dist/ 目录。使用 Sass、Autoprefixer 和 terser。 |
npm test |
运行 npm run dist 后,在本地运行测试 |
npm run docs-serve |
在本地构建并运行文档。 |
Sass
Bootstrap 使用 Dart Sass 将 Sass 源文件编译成 CSS 文件(包含在我们的构建过程中),如果您使用自己的资产管道编译 Sass,我们建议您也这样做。我们之前在 Bootstrap v4 中使用了 Node Sass,但 LibSass 和在其基础上构建的软件包(包括 Node Sass)现在已废弃。
Dart Sass 使用的四舍五入精度为 10,并且出于效率考虑不允许调整该值。在对生成的 CSS 进行进一步处理(例如在最小化过程中)时,我们不会降低该精度,但如果您选择这样做,我们建议您至少将精度保持在 6,以防止出现浏览器四舍五入的问题。
Autoprefixer
Bootstrap 使用 Autoprefixer(包含在我们的构建过程中)在构建时自动为某些 CSS 属性添加vendor前缀。这样做可以节省我们的时间和代码,让我们只需编写 CSS 的关键部分,而无需像 v3 中那样使用vendor混合脚本。
我们在 GitHub 代码库中的一个单独文件中维护 Autoprefixer 支持的浏览器列表。详情请参见 .browserslistrc 。
RTLCSS
Bootstrap 使用 RTLCSS 来处理已编译的 CSS 并将其转换为 RTL–基本上是将水平方向属性(如 padding-left
)替换为与之相反的属性。这样,我们只需编写一次 CSS,然后使用 RTLCSS control 和 value 指令稍作调整即可。
本地文档
在本地运行我们的文档需要使用 Hugo,它通过 hugo-bin npm 软件包安装。Hugo 是一款速度极快、可扩展的静态网站生成器,为我们提供了基本的包含、基于 Markdown 的文件、模板等功能。下面是如何启动它的方法:
- 运行上述 工具设置 安装所有依赖项。
- 从根目录
/bootstrap
,在命令行中运行npm run docs-serve
。 - 在浏览器中打开
http://localhost:9001/
,然后就可以了。
阅读 Hugo 文档,了解有关使用Hugo的更多信息。
疑难解答
如果在安装依赖项时遇到问题,请卸载所有先前的依赖项版本(全局和本地)。然后,重新运行 npm install
。