mirror of
https://github.com/mdbootstrap/mdb-ui-kit.git
synced 2024-11-10 19:57:13 +03:00
make building doc page more obviously titled, and link direct from the README
This commit is contained in:
parent
08a049466f
commit
d61942b298
|
@ -16,11 +16,11 @@ the end of your document (just before the `</body>` tag), and everything will be
|
|||
|
||||
NOTE: this is a temporary site location that will be published in at http://fezvrasta.github.io/bootstrap-material-design in the future.
|
||||
|
||||
- [Migration](http://rosskevin.github.io/bootstrap-material-design/migration/)
|
||||
- [Getting Started](http://rosskevin.github.io/bootstrap-material-design/getting-started/introduction/)
|
||||
- [Building](http://rosskevin.github.io/bootstrap-material-design/getting-started/building/)
|
||||
- [Material Design components](http://rosskevin.github.io/bootstrap-material-design/material-design/list-group/)
|
||||
- [Bootstrap default rendering reference documentation](http://rosskevin.github.io/bootstrap-material-design/components/buttons/)
|
||||
|
||||
- [Migration](http://rosskevin.github.io/bootstrap-material-design/migration/)
|
||||
|
||||
## Support
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
- title: Getting started
|
||||
pages:
|
||||
- title: Introduction
|
||||
- title: Building
|
||||
- title: Download
|
||||
- title: Browsers & devices
|
||||
- title: Customization
|
||||
- title: Best practices
|
||||
- title: Build tools
|
||||
- title: Release process
|
||||
|
||||
- title: Material Design
|
||||
|
|
|
@ -10,7 +10,7 @@ We've designed and developed Material Design for Bootstrap to work in a number o
|
|||
**Heads up!** This copy is a work in progress.
|
||||
{% endcallout %}
|
||||
|
||||
### General outline
|
||||
- Working with CSS
|
||||
- Working with Sass files
|
||||
- Building new CSS components
|
||||
## SASS
|
||||
|
||||
### Avoid vendor prefixes
|
||||
Material Design for Bootstrap uses Autoprefixer (included in our gulpfile and 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.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
layout: docs
|
||||
title: Build tools
|
||||
title: Building
|
||||
group: getting-started
|
||||
---
|
||||
|
||||
|
@ -31,10 +31,6 @@ Our gulpfile includes the many tasks you can view with `gulp --tasks`, here are
|
|||
| `gulp` | `gulp` runs the `default` task that builds all core files to the `dist` directory |
|
||||
| `gulp docs:default` | creates all the `docs/dist` files needed to support the documentation |
|
||||
|
||||
## Autoprefixer
|
||||
|
||||
Material Design for Bootstrap uses [Autoprefixer][autoprefixer] (included in our gulpfile and 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.
|
||||
|
||||
|
||||
## Local documentation
|
||||
|
||||
|
@ -61,7 +57,7 @@ Bootstrap checked out in parallel to this project, running two (2) different ter
|
|||
|
||||
1. Watch both the core and docs sources for changes and build to the docs site
|
||||
|
||||
`grunt docs:default:watch`
|
||||
`gulp docs:default:watch`
|
||||
|
||||
1. _Terminal 2_: Start serving documentation on <http://localhost:9000> with `jekyll serve`
|
||||
|
|
@ -7,7 +7,7 @@ group: getting-started
|
|||
Material Design for Bootstrap 4 is designed to be customized via Sass variables. You may customize any Bootstrap or BMD variable.
|
||||
|
||||
{% callout info %}
|
||||
The following assumes you have [setup your Build tools](../build-tools)
|
||||
The following assumes you have [setup your build tools and are building successfully](../building).
|
||||
{% endcallout %}
|
||||
|
||||
{% callout warning %}
|
||||
|
@ -18,11 +18,11 @@ Here are some ways to customize:
|
|||
|
||||
## 1. (Recommended) Include the source in your application
|
||||
|
||||
Installing via npm (recommended) or bower, customizing BMD is a breeze.
|
||||
Installing via `npm` (recommended) or `bower`, customizing BMD is a breeze.
|
||||
|
||||
1. Add `bootstrap-material-design` as a dependency to your `package.json` or your `bower.json`
|
||||
1. `npm install` or `bower install` depending on your tool of choice
|
||||
1. Add either `node_modules` or `bower_components` in the `includePaths` for your grunt-sass, gulp-sass, or equivalent so you are able to import without specifying the full path of the resource.
|
||||
1. `npm install` OR `bower install` depending on your tool of choice
|
||||
1. Add either `node_modules` or `bower_components` in the `includePaths` for your `grunt-sass`, `gulp-sass`, or equivalent configurations so you are able to import without specifying the full path of the resource.
|
||||
1. In your application's SCSS, redefine any customized variable _before_ `@import`ing bootstrap material design. For example:
|
||||
|
||||
~~~~~~~~
|
||||
|
@ -39,7 +39,7 @@ $mdb-label-color-focus: #303f9f; // mdb variable
|
|||
This method is not recommended because it may be difficult to use source control **and** keep up to date with new releases. Please consider the recommended method above.
|
||||
{% endcallout %}
|
||||
|
||||
1. Download the source via npm, bower or otherwise
|
||||
1. Download the source via `npm`, `bower` or otherwise
|
||||
2. Change any of the variables
|
||||
3. Run `grunt dist`
|
||||
3. Run `gulp`
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user