mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
a49ee46dae
This adds the new block syntax to dgeni docs pipeline, mainly copying the way that elements (`<ng-content>` etc.) work. Actual doc content is just a placeholder for this PR. PR Close #52123
29 lines
717 B
JavaScript
29 lines
717 B
JavaScript
/**
|
|
* @dgService
|
|
* @description
|
|
* This file reader will pull the contents from a text file that will be used
|
|
* as the description of a "block", such as `@if` or `@for`, etc.
|
|
*
|
|
* The doc will initially have the form:
|
|
* ```
|
|
* {
|
|
* docType: 'block',
|
|
* name: 'some-name',
|
|
* content: 'the content of the file',
|
|
* }
|
|
* ```
|
|
*/
|
|
module.exports = function blockFileReader() {
|
|
return {
|
|
name: 'blockFileReader',
|
|
defaultPattern: /\.md$/,
|
|
getDocs: function(fileInfo) {
|
|
// We return a single element array because element files only contain one document
|
|
return [{
|
|
docType: 'block',
|
|
name: `@${fileInfo.baseName}`,
|
|
content: fileInfo.content,
|
|
}];
|
|
}
|
|
};
|
|
};
|