Hulpmiddelen bouwen
Leer hoe u de meegeleverde npm-scripts van Bootstrap kunt gebruiken om onze documentatie te bouwen, de broncode te compileren, tests uit te voeren en meer.
Gereedschapsconfiguratie
Bootstrap gebruikt npm-scripts voor zijn bouwsysteem. Onze package.json bevat handige methoden om met het framework te werken, waaronder het compileren van code, het uitvoeren van tests en meer.
Om ons buildsysteem te gebruiken en onze documentatie lokaal uit te voeren, heb je een kopie van Bootstrap's bronbestanden en Node nodig. Volg deze stappen en je zou klaar moeten zijn om te rocken:
- Download en installeer Node.js , die we gebruiken om onze afhankelijkheden te beheren.
- Navigeer naar de hoofdmap
/bootstrap
en voernpm install
deze uit om onze lokale afhankelijkheden te installeren die worden vermeld in package.json . - Installeer Ruby , installeer Bundler met
gem install bundler
en voer ten slotte uitbundle install
. Hiermee worden alle Ruby-afhankelijkheden geïnstalleerd, zoals Jekyll en plug-ins.- Windows-gebruikers: Lees deze handleiding om Jekyll probleemloos aan de slag te krijgen.
Als u klaar bent, kunt u de verschillende opdrachten uitvoeren vanaf de opdrachtregel.
Npm-scripts gebruiken
Onze package.json bevat de volgende opdrachten en taken:
Taak | Beschrijving |
---|---|
npm run dist |
npm run dist maakt de /dist/ map met gecompileerde bestanden. Gebruikt Sass , Autoprefixer en UglifyJS . |
npm test |
Hetzelfde als npm run dist plus het voert lokaal tests uit |
npm run docs |
Bouwt en pluist CSS en JavaScript voor documenten. U kunt de documentatie vervolgens lokaal uitvoeren via npm run docs-serve . |
Uitvoeren npm run
om alle npm-scripts te zien.
Autoprefixer
Bootstrap gebruikt Autoprefixer (inbegrepen in ons bouwproces) om tijdens het bouwen automatisch leveranciersvoorvoegsels toe te voegen aan sommige CSS-eigenschappen. Door dit te doen, besparen we tijd en code doordat we de belangrijkste delen van onze CSS in één keer kunnen schrijven, terwijl we de noodzaak voor leveranciersmixins zoals die in v3.
We houden de lijst met browsers die worden ondersteund door Autoprefixer bij in een apart bestand in onze GitHub-repository. Zie .browserslistrc voor details.
Lokale documentatie
Om onze documentatie lokaal uit te voeren, is het gebruik van Jekyll vereist, een behoorlijk flexibele generator voor statische sites die ons voorziet van: basisinhoud, op Markdown gebaseerde bestanden, sjablonen en meer. Hier leest u hoe u eraan begint:
- Doorloop de tooling-instellingen hierboven om Jekyll (de sitebuilder) en andere Ruby-afhankelijkheden te installeren met
bundle install
. /bootstrap
Voer vanuit de hoofdmap uitnpm run docs-serve
in de opdrachtregel.- Open
http://localhost:9001
in uw browser en voilà.
Lees meer over het gebruik van Jekyll door de documentatie te lezen .
Probleemoplossen
Als u problemen ondervindt met het installeren van afhankelijkheden, verwijder dan alle eerdere versies van afhankelijkheid (algemeen en lokaal). Daarna opnieuw uitvoeren npm install
.