Skip to content

Commit b5f3542

Browse files
authored
chore: rename docs/ to guides/, generate html for guides (#2344)
1 parent e6fcbc0 commit b5f3542

File tree

6 files changed

+9
-6
lines changed

6 files changed

+9
-6
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ contains all of the components. Build tools such as [`rollup.js`](http://rollupj
191191
tree-shaking to eliminate the code for components that you aren't using.
192192

193193
The addition of theming as also changed the directory structure for bringing the core css into your
194-
application. See the new [theming guide](docs/theming.md) for more information.
194+
application. See the new [theming guide](guides/theming.md) for more information.
195195

196196

197197
### Features

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Playing with the latest changes from [master](https://github.com/angular/materia
2222

2323
### Getting started
2424

25-
See our [Getting Started Guide](https://github.com/angular/material2/blob/master/GETTING_STARTED.md)
25+
See our [Getting Started Guide][getting-started]
2626
if you're building your first project with Angular Material 2.
2727

2828
### Project status
@@ -114,7 +114,7 @@ High level items planned for December 2016:
114114
[17]: https://github.com/angular/material2/blob/master/src/lib/menu/README.md
115115
[18]: https://github.com/angular/material2/blob/master/src/lib/tooltip/README.md
116116
[19]: https://github.com/angular/material2/blob/master/src/lib/core/ripple/README.md
117-
[20]: https://github.com/angular/material2/blob/master/docs/theming.md
117+
[20]: https://github.com/angular/material2/blob/master/guides/theming.md
118118
[21]: https://github.com/angular/material2/blob/master/src/lib/snack-bar/README.md
119119
[22]: https://github.com/angular/material2/blob/master/src/lib/dialog/README.md
120120

@@ -136,6 +136,9 @@ High level items planned for December 2016:
136136
[0675]: https://github.com/angular/material2/issues/675
137137
[0581]: https://github.com/angular/material2/issues/581
138138

139+
[getting-started]: https://github.com/angular/material2/blob/master/guides/theming.md
140+
[theming]: https://github.com/angular/material2/blob/master/guides/theming.md
141+
139142

140143
"Available" means that the components or feature is published and available for use, but may still
141144
be missing some behaviors or polish.

GETTING_STARTED.md renamed to guides/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export class PizzaPartyAppModule { }
3737
This is **required** to apply all of the core and theme styles to your application. You can either
3838
use a pre-built theme, or define your own custom theme.
3939

40-
:trident: See the [theming guide](docs/theming.md) for instructions.
40+
:trident: See the [theming guide](guides/theming.md) for instructions.
4141

4242
### Additional setup for `md-slide-toggle` and `md-slider`:
4343
The slide-toggle and slider components have a dependency on [HammerJS](http://hammerjs.github.io/).
File renamed without changes.

docs/theming.md renamed to guides/theming.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ With this, any element inside of a parent with the `unicorn-dark-theme` class wi
106106
dark theme.
107107

108108
### Theming your own components
109-
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)
109+
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)
110110

111111
### Future work
112112
* Once CSS variables (custom properties) are available in all the browsers we support,

tools/gulp/tasks/docs.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import * as path from 'path';
1212
const EXAMPLE_PATTERN = /<!--\W*example\(([^)]+)\)\W*-->/g;
1313

1414
gulp.task('docs', () => {
15-
return gulp.src(['src/lib/**/*.md'])
15+
return gulp.src(['src/lib/**/*.md', 'guides/*.md'])
1616
.pipe(markdown({
1717
// Add syntax highlight using highlight.js
1818
highlight: (code: string, language: string) => {

0 commit comments

Comments
 (0)