Help develop Boosted with our documentation build scripts and tests.
Boosted uses npm scripts to build the documentation and compile source files. Our package.json houses these scripts for compiling code, running tests, and more. These aren’t intended for use outside our repository and documentation.
To use our build system and run our documentation locally, you’ll need a copy of Boosted’s source files and Node. Follow these steps and you should be ready to rock:
- Download and install Node.js, which we use to manage our dependencies.
- Either download Boosted’s sources or fork Boosted’s repository.
- Navigate to the root
/Orange-Boosted-Bootstrapdirectory and run
npm installto install our local dependencies listed in package.json.
When completed, you’ll be able to run the various commands provided from the command line.
Using npm scripts
Our package.json includes numerous tasks for developing the project. Run
npm run to see all the npm scripts in your terminal. Primary tasks include:
Runs tests locally after running
||Builds and runs the documentation locally.|
Boosted uses Dart Sass for compiling our Sass source files into CSS files (included in our build process), and we recommend you do the same if you’re compiling Sass using your own asset pipeline. We previously used Node Sass for Boosted v4, but LibSass and packages built on top of it, including Node Sass, are now deprecated.
Dart Sass uses a rounding precision of 10 and for efficiency reasons does not allow adjustment of this value. We don’t lower this precision during further processing of our generated CSS, such as during minification, but if you chose to do so we recommend maintaining a precision of at least 6 to prevent issues with browser rounding.
Boosted uses Autoprefixer (included in our build process) to automatically add vendor prefixes to some CSS properties at build time. Doing so saves us time and code by allowing us to write key parts of our CSS a single time while eliminating the need for vendor mixins like those found in v3.
We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See .browserslistrc for details.
Boosted uses RTLCSS to process compiled CSS and convert them to RTL – basically replacing horizontal direction aware properties (eg.
padding-left) with their opposite. It allows us only write our CSS a single time and make minor tweaks using RTLCSS control and value directives.
Running our documentation locally requires the use of Hugo, which gets installed via the hugo-bin npm package. Hugo is a blazingly fast and quite extensible static site generator that provides us: basic includes, Markdown-based files, templates, and more. Here’s how to get it started:
- Run through the tooling setup above to install all dependencies.
- From the root
npm run docs-servein the command line.
http://localhost:9001/in your browser, and voilà.
Learn more about using Hugo by reading its documentation.
Should you encounter problems with installing dependencies, uninstall all previous dependency versions (global and local). Then, rerun