Source

Ibni għodod

Tgħallem kif tuża l-iskripts npm inklużi ta' Bootstrap biex tibni d-dokumentazzjoni tagħna, tikkumpila l-kodiċi tas-sors, tmexxi testijiet, u aktar.

Setup tal-għodda

Bootstrap juża skripts npm għas-sistema tal-bini tiegħu. Il- pakkett.json tagħna jinkludi metodi konvenjenti biex taħdem mal-qafas, inkluż il-kompilazzjoni tal-kodiċi, it-tmexxija tat-testijiet, u aktar.

Biex tuża s-sistema tal-bini tagħna u tħaddem id-dokumentazzjoni tagħna lokalment, ikollok bżonn kopja tal-fajls sors u Node ta' Bootstrap. Segwi dawn il-passi u inti għandek tkun lest biex rock:

  1. Niżżel u installa Node.js , li nużaw biex niġġestixxu d-dipendenzi tagħna.
  2. Innaviga lejn id-direttorju tal-għeruq /bootstrapu mexxi npm installbiex tinstalla d-dipendenzi lokali tagħna elenkati f'package.json .
  3. Installa Ruby , installa Bundler ma ' gem install bundler, u finalment run bundle install. Dan se jinstalla d-dipendenzi kollha ta 'Ruby, bħal Jekyll u plugins.
    • Utenti tal-Windows: Aqra din il-gwida biex Jekyll jibda jaħdem mingħajr problemi.

Meta titlesta, tkun tista' tmexxi d-diversi kmandi pprovduti mil-linja tal-kmand.

Bl-użu ta 'skripts npm

package.json tagħna jinkludi l-kmandi u l-kompiti li ġejjin:

Kompitu Deskrizzjoni
npm run dist npm run distjoħloq id- /dist/direttorju b'fajls ikkumpilati. Juża Sass , Autoprefixer , u UglifyJS .
npm test L-istess bħal kif npm run distukoll imexxi testijiet lokalment
npm run docs Jibni u lints CSS u JavaScript għal docs. Tista' mbagħad tmexxi d-dokumentazzjoni lokalment permezz ta' npm run docs-serve.

Mexxi npm runbiex tara l-iskripts kollha npm.

Autoprefisser

Bootstrap juża Autoprefixer (inkluż fil-proċess tal-bini tagħna) biex iżid awtomatikament prefissi tal-bejjiegħ għal xi proprjetajiet CSS fil-ħin tal-bini. Jekk tagħmel hekk tiffranka ħin u kodiċi billi tippermettilna niktbu partijiet ewlenin tas-CSS tagħna darba waħda filwaqt li telimina l-ħtieġa għal mixins tal-bejjiegħ bħal dawk misjuba f'v3.

Aħna nżommu l-lista ta 'browsers appoġġjati permezz ta' Autoprefixer f'fajl separat fi ħdan ir-repożitorju GitHub tagħna. Ara .browserslistrc għad-dettalji.

Dokumentazzjoni lokali

It-tmexxija tad-dokumentazzjoni tagħna lokalment teħtieġ l-użu ta 'Jekyll, ġeneratur ta' sit statiku deċenti flessibbli li jipprovdilna: jinkludi bażiku, fajls ibbażati fuq Markdown, mudelli, u aktar. Hawn kif tibda:

  1. Mexxi s- setup tal-għodda ta ' hawn fuq biex tinstalla Jekyll (il-bennej tas-sit) u dipendenzi oħra ta' Ruby b' bundle install.
  2. Mid- /bootstrapdirettorju tal-għeruq, mexxi npm run docs-servefil-linja tal-kmand.
  3. Iftaħ http://localhost:9001fil-browser tiegħek, u voilà.

Tgħallem aktar dwar l-użu ta' Jekyll billi taqra d- dokumentazzjoni tiegħu .

Issolvi l-problemi

Jekk tiltaqa' ma' problemi bl-installazzjoni tad-dipendenzi, iddiżinstalla l-verżjonijiet tad-dipendenza preċedenti kollha (globali u lokali). Imbagħad, erġa' wettaq npm install.