Source

Zostavte nástroje

Zistite, ako používať skripty npm zahrnuté v Bootstrap na zostavenie našej dokumentácie, kompiláciu zdrojového kódu, spustenie testov a ďalšie.

Nastavenie nástrojov

Bootstrap používa skripty NPM pre svoj systém zostavovania. Náš súbor package.json obsahuje pohodlné metódy na prácu s rámcom vrátane kompilácie kódu, spúšťania testov a ďalších.

Ak chcete použiť náš systém zostavovania a spustiť našu dokumentáciu lokálne, budete potrebovať kópiu zdrojových súborov Bootstrapu a uzla. Postupujte podľa týchto krokov a mali by ste byť pripravení na rock:

  1. Stiahnite si a nainštalujte Node.js , ktorý používame na správu našich závislostí.
  2. Prejdite do koreňového /bootstrapadresára a spustite npm installinštaláciu našich miestnych závislostí uvedených v súbore package.json .
  3. Nainštalujte Ruby , nainštalujte Bundler s gem install bundlera nakoniec spustite bundle install. Týmto sa nainštalujú všetky závislosti Ruby, ako napríklad Jekyll a doplnky.
    • Používatelia systému Windows: Prečítajte si túto príručku , aby ste mohli Jekyll bez problémov spustiť.

Po dokončení budete môcť spúšťať rôzne príkazy poskytnuté z príkazového riadku.

Používanie skriptov NPM

Náš súbor package.json obsahuje nasledujúce príkazy a úlohy:

Úloha Popis
npm run dist npm run distvytvorí /distadresár s kompilovanými súbormi. Používa Sass , Autoprefixer a UglifyJS .
npm test Rovnako ako npm run distplus spúšťa testy lokálne
npm run docs Vytvára a prepája CSS a JavaScript pre dokumenty. Dokumentáciu potom môžete spustiť lokálne cez npm run docs-serve.

Spustením npm runzobrazíte všetky skripty npm.

Autoprefixer

Bootstrap používa Autoprefixer (zahrnutý v našom procese zostavovania) na automatické pridávanie predpôn dodávateľa k niektorým vlastnostiam CSS v čase zostavovania. To nám šetrí čas a kód, pretože nám umožňuje písať kľúčové časti nášho CSS raz a zároveň eliminuje potrebu mixov dodávateľov, ako sú tie, ktoré sa nachádzajú vo verzii 3.

Zoznam prehliadačov podporovaných prostredníctvom funkcie Autoprefixer uchovávame v samostatnom súbore v rámci nášho úložiska GitHub. Podrobnosti nájdete v /.browserslistrc .

Miestna dokumentácia

Lokálne spustenie našej dokumentácie vyžaduje použitie Jekyll, slušne flexibilného generátora statických stránok, ktorý nám poskytuje: základné položky, súbory založené na Markdown, šablóny a ďalšie. Tu je návod, ako to začať:

  1. Prejdite cez nastavenie nástrojov vyššie a nainštalujte Jekyll (tvorca stránok) a ďalšie závislosti Ruby pomocou bundle install.
  2. Z koreňového /bootstrapadresára spustite npm run docs-servev príkazovom riadku.
  3. Otvorte http://localhost:9001vo svojom prehliadači a voilà.

Viac informácií o používaní Jekyll nájdete v jeho dokumentácii .

Riešenie problémov

Ak narazíte na problémy s inštaláciou závislostí, odinštalujte všetky predchádzajúce verzie závislostí (globálne a lokálne). Potom znova spustite npm install.