Cyfrannu
Helpwch i ddatblygu Bootstrap gyda'n sgriptiau adeiladu dogfennau a phrofion.
Gosodiad offer
Mae Bootstrap yn defnyddio sgriptiau npm i adeiladu'r ddogfennaeth a llunio ffeiliau ffynhonnell. Mae ein pecyn.json yn gartref i'r sgriptiau hyn ar gyfer llunio cod, rhedeg profion, a mwy. Nid yw'r rhain wedi'u bwriadu i'w defnyddio y tu allan i'n cadwrfa a dogfennaeth.
I ddefnyddio ein system adeiladu a rhedeg ein dogfennaeth yn lleol, bydd angen copi o ffeiliau ffynhonnell Bootstrap a Node arnoch. Dilynwch y camau hyn a dylech fod yn barod i siglo:
- Lawrlwythwch a gosodwch Node.js , a ddefnyddiwn i reoli ein dibyniaethau.
- Naill ai lawrlwythwch ffynonellau Bootstrap neu fforchiwch ystorfa Bootstrap .
- Llywiwch i'r
/bootstrap
cyfeiriadur gwraidd a rhedegnpm install
i osod ein dibyniaethau lleol a restrir yn package.json .
Ar ôl ei gwblhau, byddwch yn gallu rhedeg y gwahanol orchmynion a ddarperir o'r llinell orchymyn.
Defnyddio sgriptiau npm
Mae ein pecyn.json yn cynnwys nifer o dasgau ar gyfer datblygu'r prosiect. Rhedeg npm run
i weld yr holl sgriptiau npm yn eich terfynell. Mae tasgau cynradd yn cynnwys:
Tasg | Disgrifiad |
---|---|
npm start |
Yn llunio CSS a JavaScript, yn adeiladu'r ddogfennaeth, ac yn cychwyn gweinydd lleol. |
npm run dist |
Yn creu'r dist/ cyfeiriadur gyda ffeiliau wedi'u llunio. Yn defnyddio Sass , Autoprefixer , a terser . |
npm test |
Yn rhedeg profion yn lleol ar ôl rhedegnpm run dist |
npm run docs-serve |
Adeiladu a rhedeg y ddogfennaeth yn lleol. |
Sass
Mae Bootstrap yn defnyddio Dart Sass ar gyfer crynhoi ein ffeiliau ffynhonnell Sass yn ffeiliau CSS (wedi'u cynnwys yn ein proses adeiladu), ac rydym yn argymell eich bod yn gwneud yr un peth os ydych chi'n llunio Sass gan ddefnyddio'ch piblinell asedau eich hun. Yn flaenorol, gwnaethom ddefnyddio Node Sass ar gyfer Bootstrap v4, ond mae LibSass a phecynnau a adeiladwyd ar ei ben, gan gynnwys Node Sass, bellach yn anghymeradwy .
Mae Dart Sass yn defnyddio trachywiredd talgrynnu o 10 ac am resymau effeithlonrwydd nid yw'n caniatáu addasu'r gwerth hwn. Nid ydym yn lleihau'r manwl gywirdeb hwn wrth brosesu'r CSS a gynhyrchir gennym ymhellach, megis yn ystod y minio, ond os dewiswch wneud hynny rydym yn argymell cadw o leiaf 6 manwl gywirdeb i atal problemau gyda thalgrynnu porwr.
Autoprefixer
Mae Bootstrap yn defnyddio Autoprefixer (wedi'i gynnwys yn ein proses adeiladu) i ychwanegu rhagddodiaid gwerthwyr yn awtomatig i rai eiddo CSS ar amser adeiladu. Mae gwneud hynny yn arbed amser a chod i ni trwy ganiatáu i ni ysgrifennu rhannau allweddol o'n CSS un tro tra'n dileu'r angen am gymysgeddau gwerthwyr fel y rhai a geir yn v3.
Rydym yn cynnal y rhestr o borwyr a gefnogir trwy Autoprefixer mewn ffeil ar wahân yn ein cadwrfa GitHub. Gweler .browserslistrc am fanylion.
RTLCSS
Mae Bootstrap yn defnyddio RTLCSS i brosesu CSS wedi'i lunio a'u trosi i RTL - yn y bôn gan ddisodli eiddo sy'n ymwybodol o gyfeiriad llorweddol (ee padding-left
) gyda'u gwrthwyneb. Mae'n caniatáu inni ysgrifennu ein CSS un tro yn unig a gwneud mân newidiadau gan ddefnyddio cyfarwyddebau rheoli a gwerth RTLCSS .
Dogfennaeth leol
Er mwyn rhedeg ein dogfennaeth yn lleol mae angen defnyddio Hugo, sy'n cael ei osod trwy'r pecyn hugo-bin npm. Mae Hugo yn gynhyrchydd gwefan sefydlog syfrdanol o gyflym ac eithaf estynadwy sy'n darparu i ni: sylfaenol yn cynnwys, ffeiliau yn seiliedig ar Markdown, templedi, a mwy. Dyma sut i roi cychwyn arni:
- Rhedwch trwy'r gosodiad offer uchod i osod pob dibyniaeth.
/bootstrap
O'r cyfeiriadur gwraidd , rhedegnpm run docs-serve
yn y llinell orchymyn.- Agorwch
http://localhost:9001/
yn eich porwr, a voilà.
Dysgwch fwy am ddefnyddio Hugo trwy ddarllen ei ddogfennaeth .
Datrys problemau
Os cewch chi broblemau gyda gosod dibyniaethau, dadosodwch yr holl fersiynau dibyniaeth blaenorol (byd-eang a lleol). Yna, ail-redeg npm install
.