fix stuff

This commit is contained in:
Federico Zivolo 2017-09-10 17:44:42 +02:00
parent b4da895865
commit 4fb10c33cb
3 changed files with 13 additions and 8 deletions

View File

@ -26,7 +26,7 @@
// Load Bootstrap variables and mixins
@import "../../scss/functions";
@import "../../scss/variables";
@import "bootstrap/scss/mixins";
@import "~bootstrap/scss/mixins";
@import "../../scss/mixins";
// Load docs components

View File

@ -8,12 +8,12 @@ toc: true
## Tooling setup
Bootstrap uses [NPM scripts](https://docs.npmjs.com/misc/scripts) for its build system. Our [package.json](https://github.com/twbs/bootstrap/blob/v4-dev/package.json) includes convenient methods for working with the framework, including compiling code, running tests, and more.
Bootstrap uses [NPM scripts](https://docs.npmjs.com/misc/scripts) for its build system. Our [package.json](https://github.com/FezVrasta/bootstrap-material-design/blob/v4/package.json) includes convenient methods for working with the framework, including compiling code, running tests, and more.
To use our build system and run our documentation locally, you'll need a copy of Bootstrap's source files and Node. Follow these steps and you should be ready to rock:
1. [Download and install Node](https://nodejs.org/download/), which we use to manage our dependencies.
2. Navigate to the root `/bootstrap` directory and run `npm install` to install our local dependencies listed in [package.json](https://github.com/twbs/bootstrap/blob/master/package.json).
2. Navigate to the root `/bootstrap` directory and run `npm install` to install our local dependencies listed in [package.json](https://github.com/FezVrasta/bootstrap-material-design/blob/v4/package.json).
4. [Install Ruby][install-ruby], install [Bundler][gembundler] with `gem install bundler`, and finally run `bundle install`. This will install all Ruby dependencies, such as Jekyll and plugins.
- **Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems.
@ -24,13 +24,13 @@ When completed, you'll be able to run the various commands provided from the com
## Using NPM scripts
Our [package.json](https://github.com/twbs/bootstrap/blob/master/package.json) includes the following commands and tasks:
Our [package.json](https://github.com/FezVrasta/bootstrap-material-design/blob/v4/package.json) includes the following commands and tasks:
| Task | Description |
| --- | --- |
| `npm test` | Run `npm test` to run tests locally and compile the CSS and JavaScript into `/dist`. **Uses [Sass](http://sass-lang.com/), [Autoprefixer][autoprefixer], and [UglifyJS](http://lisperator.net/uglifyjs/).** |
| `npm run dist` | `npm run dist` creates the `/dist` directory with compiled files. **Uses [Sass](http://sass-lang.com/), [Autoprefixer][autoprefixer], and [UglifyJS](http://lisperator.net/uglifyjs/).** |
| `npm run docs` | Builds and tests CSS, JavaScript, and other assets which are used when running the documentation locally via `npm run docs-serve`. |
| `npm run docs` | Builds and tests CSS, JavaScript, and other assets which are used when running the documentation locally via `npm run docs:serve`. |
## Autoprefixer
@ -48,6 +48,13 @@ Running our documentation locally requires the use of Jekyll, a decently flexibl
Learn more about using Jekyll by reading its [documentation](https://jekyllrb.com/docs/home/).
## Sass
We use Sass to write our CSS stylesheets, unfortunately, due to discrepancies between versions, we decided to support only the implementation provided by [LibSass](http://sass-lang.com/libsass).
This means that you won't be able to compile the stylesheets using `ruby-sass`.
To learn more about the differences please read [this article](http://sassbreak.com/ruby-sass-libsass-differences/).
## Troubleshooting
Should you encounter problems with installing dependencies, uninstall all previous dependency versions (global and local). Then, rerun `npm install`.

View File

@ -40,9 +40,6 @@
"url": "https://github.com/FezVrasta/bootstrap-material-design/issues"
},
"license": "MIT",
"dependencies": {
"node-sass-tilde-importer": "^1.0.0"
},
"devDependencies": {
"babel-core": "^6.25.0",
"babel-minify": "^0.2.0",
@ -54,6 +51,7 @@
"cssnano-cli": "^1.0.5",
"jquery": ">=3.0.0",
"node-sass": "^4.5.3",
"node-sass-tilde-importer": "^1.0.0",
"popper.js": "^1.11.0",
"prettier": "^1.5.3",
"rollup": "^0.45.2",