Skip to content

Commit 3d12d08

Browse files
chore(docs): add a processor to get the name of a guide doc from its markdown
1 parent 83f650f commit 3d12d08

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

docs/dgeni-package/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ module.exports = new Package('angular', [jsdocPackage, nunjucksPackage])
2929
.processor(require('./processors/processModuleDocs'))
3030
.processor(require('./processors/processClassDocs'))
3131
.processor(require('./processors/generateNavigationDoc'))
32-
32+
.processor(require('./processors/extractTitleFromGuides'))
3333

3434
// Configure the log service
3535
.config(function(log) {
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
var _ = require('lodash');
2+
3+
module.exports = function extractTitleFromGuides() {
4+
5+
return {
6+
$runAfter: ['processing-docs'],
7+
$runBefore: ['docs-processed'],
8+
$process: function(docs) {
9+
_(docs).forEach(function(doc) {
10+
if (doc.docType === 'guide') {
11+
doc.name = doc.name || getNameFromHeading(doc.description);
12+
}
13+
});
14+
}
15+
};
16+
};
17+
18+
19+
function getNameFromHeading(text) {
20+
var match = /^\s*#\s*(.*)/.exec(text);
21+
if (match) {
22+
return match[1];
23+
}
24+
}

0 commit comments

Comments
 (0)