Source

Bumuo ng mga tool

Matutunan kung paano gamitin ang mga kasamang npm script ng Bootstrap upang buuin ang aming dokumentasyon, i-compile ang source code, magpatakbo ng mga pagsubok, at higit pa.

Pag-setup ng tool

Gumagamit ang Bootstrap ng mga NPM script para sa build system nito. Kasama sa aming package.json ang mga maginhawang pamamaraan para sa pagtatrabaho sa framework, kabilang ang pag-compile ng code, pagpapatakbo ng mga pagsubok, at higit pa.

Para magamit ang aming build system at lokal na patakbuhin ang aming dokumentasyon, kakailanganin mo ng kopya ng mga source file at Node ng Bootstrap. Sundin ang mga hakbang na ito at dapat ay handa ka nang mag-rock:

  1. I-download at i-install ang Node.js , na ginagamit namin upang pamahalaan ang aming mga dependency.
  2. Mag-navigate sa root /bootstrapdirectory at tumakbo npm installpara i-install ang aming mga lokal na dependency na nakalista sa package.json .
  3. I- install ang Ruby , i-install ang Bundler gamit ang gem install bundler, at sa wakas ay tumakbo bundle install. I-install nito ang lahat ng dependency ng Ruby, tulad ng Jekyll at mga plugin.
    • Mga user ng Windows: Basahin ang gabay na ito para mapatakbo si Jekyll nang walang problema.

Kapag nakumpleto na, magagawa mong patakbuhin ang iba't ibang mga command na ibinigay mula sa command line.

Gamit ang mga script ng NPM

Kasama sa aming package.json ang mga sumusunod na command at gawain:

Gawain Paglalarawan
npm run dist npm run distlumilikha ng /distdirektoryo na may pinagsama-samang mga file. Gumagamit ng Sass , Autoprefixer , at UglifyJS .
npm test Kapareho ng npm run distplus nagpapatakbo ito ng mga pagsubok nang lokal
npm run docs Bumubuo at nagli-lint ng CSS at JavaScript para sa mga doc. Maaari mong patakbuhin ang dokumentasyon nang lokal sa pamamagitan ng npm run docs-serve.

Patakbuhin npm runupang makita ang lahat ng mga script ng npm.

Autoprefixer

Gumagamit ang Bootstrap ng Autoprefixer (kasama sa aming proseso ng pagbuo) upang awtomatikong magdagdag ng mga prefix ng vendor sa ilang mga katangian ng CSS sa oras ng pagbuo. Ang paggawa nito ay nakakatipid sa amin ng oras at code sa pamamagitan ng pagpapahintulot sa amin na magsulat ng mga mahahalagang bahagi ng aming CSS nang isang beses habang inaalis ang pangangailangan para sa mga mixin ng vendor tulad ng makikita sa v3.

Pinapanatili namin ang listahan ng mga browser na sinusuportahan sa pamamagitan ng Autoprefixer sa isang hiwalay na file sa loob ng aming GitHub repository. Tingnan ang /package.json para sa mga detalye.

Lokal na dokumentasyon

Ang pagpapatakbo ng aming dokumentasyon nang lokal ay nangangailangan ng paggamit ng Jekyll, isang disenteng flexible na static na generator ng site na nagbibigay sa amin ng: basic na kasama, Markdown-based na mga file, template, at higit pa. Narito kung paano ito sisimulan:

  1. Patakbuhin ang tooling setup sa itaas upang i-install ang Jekyll (ang tagabuo ng site) at iba pang mga dependency ng Ruby na may bundle install.
  2. Mula sa root /bootstrapdirectory, tumakbo npm run docs-servesa command line.
  3. Buksan http://localhost:9001sa iyong browser, at voilà.

Matuto nang higit pa tungkol sa paggamit ng Jekyll sa pamamagitan ng pagbabasa ng dokumentasyon nito .

Pag-troubleshoot

Kung makatagpo ka ng mga problema sa pag-install ng mga dependency, i-uninstall ang lahat ng nakaraang bersyon ng dependency (global at lokal). Pagkatapos, muling ipalabas npm install.