Osallistu

Auta kehittämään Bootstrapia dokumentaation koontiskripteillämme ja -testeillämme.

Tällä sivulla

Työkalujen asennus

Bootstrap käyttää npm-skriptejä dokumentaation rakentamiseen ja lähdetiedostojen kääntämiseen. Meidän package.json sisältää nämä komentosarjat koodin kääntämistä, testien suorittamista ja paljon muuta varten. Näitä ei ole tarkoitettu käytettäväksi arkiston ja dokumentaatiomme ulkopuolella.

Tarvitset kopion Bootstrapin lähdetiedostoista ja Nodesta, jotta voit käyttää rakennusjärjestelmäämme ja suorittaa dokumentaatiomme paikallisesti. Noudata näitä ohjeita ja sinun pitäisi olla valmis rokkaamaan:

Lataa ja asenna Node.js , jota käytämme riippuvuutemme hallintaan.
Lataa joko Bootstrapin lähteet tai haarukka Bootstrapin arkisto .
Siirry juurihakemistoon /bootstrapja suorita npm installasentaaksesi paketti.jsonissa luetellut paikalliset riippuvuutemme .

Kun olet valmis, voit suorittaa erilaisia komentoriviltä annettuja komentoja.

npm-skriptien käyttö

Paketti.json sisältää lukuisia tehtäviä projektin kehittämiseen . Suorita npm runnähdäksesi kaikki päätelaitteen npm-skriptit. Päätehtäviin kuuluvat:

Tehtävä	Kuvaus
`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 käyttää Dart Sassia Sass-lähdetiedostojemme kääntämiseen CSS-tiedostoiksi (sisältyy rakennusprosessiimme), ja suosittelemme, että teet samoin, jos käännät Sassia käyttämällä omaa resurssiputkeasi. Käytimme aiemmin Node Sassia Bootstrap v4:lle, mutta LibSass ja sen päälle rakennetut paketit, mukaan lukien Node Sass, ovat nyt poistettu käytöstä .

Dart Sass käyttää pyöristystarkkuutta 10, eikä tehokkuussyistä salli tämän arvon säätämistä. Emme alenna tätä tarkkuutta luodun CSS:n jatkokäsittelyn aikana, kuten pienentämisen aikana, mutta jos päätit tehdä niin, suosittelemme säilyttämään vähintään 6:n tarkkuuden selaimen pyöristysongelmien välttämiseksi.

Automaattinen etuliite

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:

Run through the tooling setup above to install all dependencies.
From the root /bootstrap directory, run npm run docs-serve in the command line.
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.