Builds status
Master Branch
This is the branch you'll see on documentations sites sn.cf/socledesign
Dev Branch
This is developement branch, be careful, it could destroy your computer and burn your mouse.
Requirements
-
npm 5.6.0
ORyarn 1.15.2
(follow instructions from Yarn or NPM officials to install last versions on Debian/Ubuntu systems node v8.10.0
How to build
First steps, install dependencies, go inside bootstrap-sncf directory, then :
-
yarn install
to install Node.js dependencies. -
Documentation building only Run through the tooling setup to install Jekyll (the site builder) and other Ruby dependencies with
bundle install
.
To compile Bootstrap-SNCF you will have to :
- Decide which version you need (intern or extern, cf. SNCF Digital resources)
- Run
yarn run build-intern
oryarn run build-extern
to build all the project, including distributed CSS and JavaScript files, as well as our docs assets. - Run
yarn run dist-intern
oryarn run dist-extern
to generatedist/
folder with minified css & js, and assets (icons & fonts).
Running documentation locally
Bootstrap's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at https://getbootstrap.com/. The docs may also be run locally.
Documentation search is powered by Algolia's DocSearch.
- From the root
/bootstrap-sncf
directory, runyarn run docs-serve-intern
oryarn run docs-serve-extern
in the command line after building the version you want - Open
http://localhost:9001
in your browser, and voilà. Modifications intemplate
folder will force regenerating.
Learn more about using Jekyll by reading its documentation.
NPM
Simply use npm install @sncf/bootstrap-sncf.metier
or npm install @sncf/bootstrap-sncf.communication
depending on the purpose of your project.
Icofont
- Run
yarn run icofont