Gean nei haadynhâld Gean nei dokumintnavigaasje
Check
in English

Bydrage

Help mei it ûntwikkeljen fan Bootstrap mei ús dokumintaasje bouwskripts en tests.

Op dizze side

Tooling opset

Bootstrap brûkt npm-skripts om de dokumintaasje te bouwen en boarnebestannen te kompilearjen. Us package.json befettet dizze skripts foar it kompilearjen fan koade, it útfieren fan tests, en mear. Dizze binne net bedoeld foar gebrûk bûten ús repository en dokumintaasje.

Om ús buildsysteem te brûken en ús dokumintaasje lokaal út te fieren, hawwe jo in kopy fan Bootstrap's boarnebestannen en Node nedich. Folgje dizze stappen en jo moatte ree wêze om te rocken:

  1. Download en ynstallearje Node.js , dy't wy brûke om ús ôfhinklikens te behearjen.
  2. Of download Bootstrap's boarnen of fork Bootstrap's repository .
  3. Navigearje nei de root- /bootstrapmap en rinne npm installom ús lokale ôfhinklikens te ynstallearjen neamd yn package.json .

As jo ​​​​foltôge binne, kinne jo de ferskate kommando's útfiere fan 'e kommandorigel.

It brûken fan npm-skripts

Us package.json omfettet tal fan taken foar it ûntwikkeljen fan it projekt. Rinne npm runom alle npm-skripts yn jo terminal te sjen. Primêre taken omfetsje:

Taak Beskriuwing
npm start Compiles CSS and JavaScript, builds the documentation, and starts a local server.
npm run dist Creates the dist/ directory with compiled files. Uses Sass, Autoprefixer, and terser.
npm test Runs tests locally after running npm run dist
npm run docs-serve Builds and runs the documentation locally.
Get started with Bootstrap via npm with our starter project! Head to the twbs/bootstrap-npm-starter template repository to see how to build and customize Bootstrap in your own npm project. Includes Sass compiler, Autoprefixer, Stylelint, PurgeCSS, and Bootstrap Icons.

Sass

Bootstrap uses Dart Sass for compiling our Sass source files into CSS files (included in our build process), and we recommend you do the same if you’re compiling Sass using your own asset pipeline. We previously used Node Sass for Bootstrap v4, but LibSass and packages built on top of it, including Node Sass, are now deprecated.

Dart Sass uses a rounding precision of 10 and for efficiency reasons does not allow adjustment of this value. We don’t lower this precision during further processing of our generated CSS, such as during minification, but if you chose to do so we recommend maintaining a precision of at least 6 to prevent issues with browser rounding.

Autoprefixer

Bootstrap uses Autoprefixer (included in our build process) to automatically add vendor prefixes to some CSS properties at build time. Doing so saves us time and code by allowing us to write key parts of our CSS a single time while eliminating the need for vendor mixins like those found in v3.

We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See .browserslistrc for details.

RTLCSS

Bootstrap uses RTLCSS to process compiled CSS and convert them to RTL – basically replacing horizontal direction aware properties (e.g. padding-left) with their opposite. It allows us only write our CSS a single time and make minor tweaks using RTLCSS control and value directives.

Local documentation

Running our documentation locally requires the use of Hugo, which gets installed via the hugo-bin npm package. Hugo is a blazingly fast and quite extensible static site generator that provides us: basic includes, Markdown-based files, templates, and more. Here’s how to get it started:

  1. Run through the tooling setup above to install all dependencies.
  2. From the root /bootstrap directory, run npm run docs-serve in the command line.
  3. Open http://localhost:9001/ in your browser, and voilà.

Learn more about using Hugo by reading its documentation.

Troubleshooting

Should you encounter problems with installing dependencies, uninstall all previous dependency versions (global and local). Then, rerun npm install.