Skip to content

Commit

Permalink
build(docs): exclude readme files (#8087)
Browse files Browse the repository at this point in the history
* No longer copies and prefixes `README.md` files for the docs. Those are just in the repository for a better overview, but don't really have any use for the docs. Also they are conflicting with the `fetch` script on the material.angular.io repository.

```
cp: will not overwrite just-created './src/assets/documents/overview/material-README.html' with '../material2/dist/docs/markdown/slide-toggle/material-README.html'
cp: will not overwrite just-created './src/assets/documents/overview/material-README.html' with '../material2/dist/docs/markdown/slider/material-README.html'
cp: will not overwrite just-created './src/assets/documents/overview/material-README.html' with '../material2/dist/docs/markdown/snack-bar/material-README.html'
cp: will not overwrite just-created './src/assets/documents/overview/material-README.html' with '../material2/dist/docs/markdown/tabs/material-README.html'
cp: will not overwrite just-created './src/assets/documents/overview/material-README.html' with '../material2/dist/docs/markdown/toolbar/material-README.html'
cp: will not overwrite just-created './src/assets/documents/overview/material-README.html' with '../material2/dist/docs/markdown/tooltip/material-README.html'
`
* Also updates the `example-module.ts` file to the current state of the material-examples.
  • Loading branch information
devversion authored and mmalerba committed Oct 27, 2017
1 parent 4efb70c commit b3a493c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/material-examples/example-module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -697,7 +697,7 @@ export const EXAMPLE_COMPONENTS = {
selectorName: null
},
'table-overview': {
title: 'Feature-rich data table',
title: 'Data table with sorting, pagination, and filtering.',
component: TableOverviewExample,
additionalFiles: null,
selectorName: null
Expand Down
4 changes: 2 additions & 2 deletions tools/gulp/tasks/docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ task('markdown-docs', () => {
}
};

return src(['src/lib/**/*.md', 'guides/*.md'])
return src(['src/lib/**/!(README).md', 'guides/*.md'])
.pipe(rename({prefix: 'material-'}))
.pipe(markdown(markdownOptions))
.pipe(transform(transformMarkdownFiles))
Expand All @@ -112,7 +112,7 @@ task('markdown-docs', () => {
// disambiguating the output.
/** Generates html files from the markdown overviews and guides for the cdk. */
task('markdown-docs-cdk', () => {
return src(['src/cdk/**/*.md'])
return src(['src/cdk/**/!(README).md'])
.pipe(rename({prefix: 'cdk-'}))
.pipe(markdown(markdownOptions))
.pipe(transform(transformMarkdownFiles))
Expand Down

0 comments on commit b3a493c

Please sign in to comment.