chore: rename docs/ to guides/, generate html for guides (#2344)

This commit is contained in:
Jeremy Elbourn
2016-12-22 09:13:48 -08:00
committed by GitHub
parent e6fcbc020b
commit b5f35429cb
6 changed files with 9 additions and 6 deletions
+1 -1
View File
@@ -191,7 +191,7 @@ contains all of the components. Build tools such as [`rollup.js`](http://rollupj
tree-shaking to eliminate the code for components that you aren't using.
The addition of theming as also changed the directory structure for bringing the core css into your
application. See the new [theming guide](docs/theming.md) for more information.
application. See the new [theming guide](guides/theming.md) for more information.
### Features
+5 -2
View File
@@ -22,7 +22,7 @@ Playing with the latest changes from [master](https://github.com/angular/materia
### Getting started
See our [Getting Started Guide](https://github.com/angular/material2/blob/master/GETTING_STARTED.md)
See our [Getting Started Guide][getting-started]
if you're building your first project with Angular Material 2.
### Project status
@@ -114,7 +114,7 @@ High level items planned for December 2016:
[17]: https://github.com/angular/material2/blob/master/src/lib/menu/README.md
[18]: https://github.com/angular/material2/blob/master/src/lib/tooltip/README.md
[19]: https://github.com/angular/material2/blob/master/src/lib/core/ripple/README.md
[20]: https://github.com/angular/material2/blob/master/docs/theming.md
[20]: https://github.com/angular/material2/blob/master/guides/theming.md
[21]: https://github.com/angular/material2/blob/master/src/lib/snack-bar/README.md
[22]: https://github.com/angular/material2/blob/master/src/lib/dialog/README.md
@@ -136,6 +136,9 @@ High level items planned for December 2016:
[0675]: https://github.com/angular/material2/issues/675
[0581]: https://github.com/angular/material2/issues/581
[getting-started]: https://github.com/angular/material2/blob/master/guides/theming.md
[theming]: https://github.com/angular/material2/blob/master/guides/theming.md
"Available" means that the components or feature is published and available for use, but may still
be missing some behaviors or polish.
@@ -37,7 +37,7 @@ export class PizzaPartyAppModule { }
This is **required** to apply all of the core and theme styles to your application. You can either
use a pre-built theme, or define your own custom theme.
:trident: See the [theming guide](docs/theming.md) for instructions.
:trident: See the [theming guide](guides/theming.md) for instructions.
### Additional setup for `md-slide-toggle` and `md-slider`:
The slide-toggle and slider components have a dependency on [HammerJS](http://hammerjs.github.io/).
+1 -1
View File
@@ -106,7 +106,7 @@ With this, any element inside of a parent with the `unicorn-dark-theme` class wi
dark theme.
### Theming your own components
For more details about theming your own components, see [theming-your-components.md](https://github.com/angular/material2/blob/master/docs/theming-your-components.md)
For more details about theming your own components, see [theming-your-components.md](https://github.com/angular/material2/blob/master/guides/theming-your-components.md)
### Future work
* Once CSS variables (custom properties) are available in all the browsers we support,
+1 -1
View File
@@ -12,7 +12,7 @@ import * as path from 'path';
const EXAMPLE_PATTERN = /<!--\W*example\(([^)]+)\)\W*-->/g;
gulp.task('docs', () => {
return gulp.src(['src/lib/**/*.md'])
return gulp.src(['src/lib/**/*.md', 'guides/*.md'])
.pipe(markdown({
// Add syntax highlight using highlight.js
highlight: (code: string, language: string) => {