Panustada
Aidake Bootstrapi arendada meie dokumentatsiooni koostamise skriptide ja testidega.
Tööriistade seadistamine
Bootstrap kasutab dokumentatsiooni koostamiseks ja lähtefailide kompileerimiseks npm-skripte . Meie package.json sisaldab neid skripte koodi koostamiseks, testide käitamiseks ja muuks. Need ei ole mõeldud kasutamiseks väljaspool meie hoidlat ja dokumentatsiooni.
Meie ehitussüsteemi kasutamiseks ja dokumentatsiooni kohapeal käitamiseks vajate Bootstrapi lähtefailide ja sõlme koopiat. Järgige neid samme ja peaksite olema rokkimiseks valmis:
- Laadige alla ja installige Node.js , mida kasutame oma sõltuvuste haldamiseks.
- Laadige alla Bootstrapi allikad või ühendage Bootstrapi hoidla .
- Navigeerige juurkataloogi
/bootstrap
ja käivitage failis package.jsonnpm install
loetletud kohalike sõltuvuste installimiseks .
Kui olete lõpetanud, saate käivitada erinevaid käsurealt antud käske.
Npm-skriptide kasutamine
Meie package.json sisaldab mitmeid ülesandeid projekti arendamiseks. Käivitage npm run
, et näha kõiki oma terminalis olevaid npm-skripte. Peamiste ülesannete hulka kuuluvad:
Ülesanne | Kirjeldus |
---|---|
npm start |
Kompileerib CSS-i ja JavaScripti, koostab dokumentatsiooni ja käivitab kohaliku serveri. |
npm run dist |
Loob dist/ kompileeritud failidega kataloogi. Kasutab Sassi , Autoprefixerit ja terserit . |
npm test |
Käivitab pärast käivitamist kohapeal testenpm run dist |
npm run docs-serve |
Ehitab ja käitab dokumentatsiooni kohapeal. |
Sass
Bootstrap kasutab Dart Sassi meie Sassi lähtefailide kompileerimiseks CSS-failideks (kaasatud meie ehitusprotsessis) ja soovitame teil teha sama, kui kompileerite Sassi oma varade konveieri abil. Varem kasutasime Bootstrap v4 jaoks Node Sassi, kuid LibSass ja selle peale ehitatud paketid, sealhulgas Node Sass, on nüüd aegunud .
Dart Sass kasutab ümardamise täpsust 10 ja tõhususe huvides ei võimalda seda väärtust reguleerida. Me ei vähenda seda täpsust meie loodud CSS-i edasisel töötlemisel, näiteks minimeerimisel, kuid kui otsustasite nii teha, soovitame säilitada täpsus vähemalt 6, et vältida probleeme brauseri ümardamisega.
Autoprefikser
Bootstrap kasutab automaatprefikserit (mis sisaldub meie ehitusprotsessis), et lisada mõnele CSS-i atribuudile koostamise ajal automaatselt hankija eesliited. See säästab meie aega ja koodi, võimaldades meil kirjutada oma CSS-i põhiosad ühe korra, kõrvaldades samal ajal vajaduse hankijate miksinide järele, nagu need, mida leidub versioonis 3.
Hoiame Autoprefixeri kaudu toetatud brauserite loendit eraldi failis meie GitHubi hoidlas. Vaadake üksikasju .browserslistrc .
RTLCSS
Bootstrap kasutab kompileeritud CSS-i töötlemiseks ja RTL-i teisendamiseks RTLCSSpadding-left
-i – põhimõtteliselt asendades horisontaalsed suunateadlikud omadused (nt ) nende vastandiga. See võimaldab meil CSS-i kirjutada ainult ühe korra ja teha väiksemaid muudatusi, kasutades RTLCSS-i juhtimis- ja väärtusdirektiive .
Kohalik dokumentatsioon
Meie dokumentatsiooni lokaalne käitamine nõuab Hugo kasutamist, mis installitakse paketi hugo-bin npm kaudu. Hugo on lõõgastavalt kiire ja üsna laiendatav staatiline saidigeneraator, mis pakub meile: põhilised, Markdown-põhised failid, mallid ja palju muud. Selle käivitamiseks tehke järgmist.
- Kõigi sõltuvuste installimiseks käivitage ülaltoodud tööriistade seadistus .
/bootstrap
Käivitage juurkataloogistnpm run docs-serve
käsureal.- Avage
http://localhost:9001/
oma brauseris ja voilà.
Lisateavet Hugo kasutamise kohta leiate selle dokumentatsioonist .
Veaotsing
Kui teil tekib sõltuvuste installimisel probleeme, desinstallige kõik eelmised sõltuvuse versioonid (globaalne ja kohalik). Seejärel käivitage uuesti npm install
.