Skip to content

Commit b3a493c

Browse files
devversionmmalerba
authored andcommitted
build(docs): exclude readme files (#8087)
* 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.
1 parent 4efb70c commit b3a493c

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

src/material-examples/example-module.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -697,7 +697,7 @@ export const EXAMPLE_COMPONENTS = {
697697
selectorName: null
698698
},
699699
'table-overview': {
700-
title: 'Feature-rich data table',
700+
title: 'Data table with sorting, pagination, and filtering.',
701701
component: TableOverviewExample,
702702
additionalFiles: null,
703703
selectorName: null

tools/gulp/tasks/docs.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ task('markdown-docs', () => {
100100
}
101101
};
102102

103-
return src(['src/lib/**/*.md', 'guides/*.md'])
103+
return src(['src/lib/**/!(README).md', 'guides/*.md'])
104104
.pipe(rename({prefix: 'material-'}))
105105
.pipe(markdown(markdownOptions))
106106
.pipe(transform(transformMarkdownFiles))
@@ -112,7 +112,7 @@ task('markdown-docs', () => {
112112
// disambiguating the output.
113113
/** Generates html files from the markdown overviews and guides for the cdk. */
114114
task('markdown-docs-cdk', () => {
115-
return src(['src/cdk/**/*.md'])
115+
return src(['src/cdk/**/!(README).md'])
116116
.pipe(rename({prefix: 'cdk-'}))
117117
.pipe(markdown(markdownOptions))
118118
.pipe(transform(transformMarkdownFiles))

0 commit comments

Comments
 (0)