600402d440
All the docs related files (docs-app, doc-gen, content, etc)
are now to be found inside the `/aio` folder.
The related gulp tasks have been moved from the top level
gulp file to a new one inside the `/aio` folder.
The structure of the `/aio` folder now looks like:
```
/aio/
build/ # gulp tasks
content/ #MARKDOWN FILES for devguides, cheatsheet, etc
devguides/
cheatsheets/
transforms/ #dgeni packages, templates, etc
src/
app/
assets/
content/ #HTML + JSON build artifacts produced by dgeni from /aio/content.
#This dir is .gitignored-ed
e2e/ #protractor tests for the doc viewer app
node_modules/ #dependencies for both the doc viewer builds and the dgeni stuff
#This dir is .gitignored-ed
gulpfile.js #Tasks for generating docs and building & deploying the doc viewer
```
Closes #14361
26 lines
622 B
JavaScript
26 lines
622 B
JavaScript
var path = require('canonical-path');
|
|
|
|
/**
|
|
* @dgService
|
|
* @description
|
|
* This file reader will pull the contents from a text file (by default .md)
|
|
*
|
|
* The doc will initially have the form:
|
|
* ```
|
|
* {
|
|
* content: 'the content of the file',
|
|
* startingLine: 1
|
|
* }
|
|
* ```
|
|
*/
|
|
module.exports = function contentFileReader() {
|
|
return {
|
|
name: 'contentFileReader',
|
|
defaultPattern: /\.md$/,
|
|
getDocs: function(fileInfo) {
|
|
|
|
// We return a single element array because content files only contain one document
|
|
return [{docType: 'content', content: fileInfo.content, startingLine: 1}];
|
|
}
|
|
};
|
|
}; |