Skip to content

Commit 3db56d9

Browse files
committed
Drag a little more meta data around
1 parent 545dd65 commit 3db56d9

File tree

2 files changed

+18
-53
lines changed

2 files changed

+18
-53
lines changed

docs/.vuepress/jsdoc.js

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ dirs.forEach(dir => {
3232
})
3333

3434
const templateData = jsdoc2md.getTemplateDataSync({
35-
files: path.resolve('src/**/*.js')
35+
files: path.resolve('src/**/**/*.js')
3636
})
3737

3838
documentClasses(templateData)
@@ -44,7 +44,14 @@ documentClasses(templateData)
4444
*/
4545
function documentClasses (templateData) {
4646
const classes = templateData.reduce((classNames, identifier) => {
47-
if (identifier.kind === 'class') classNames.push(identifier.name)
47+
if (identifier.kind === 'class') {
48+
let name = identifier.name
49+
classNames.push({
50+
name,
51+
path: identifier.meta.path,
52+
uniqueName: identifier.meta.path.replace(path.resolve(__dirname, '../../src'), '')
53+
})
54+
}
4855
return classNames
4956
}, [])
5057

@@ -53,29 +60,29 @@ function documentClasses (templateData) {
5360
}
5461

5562
for (const cls of classes) {
56-
classIndexData.classes[cls] = {
57-
name: cls,
58-
link: cls + '.html'
63+
classIndexData.classes[cls.name] = {
64+
name: cls.name,
65+
link: cls.name + '.html'
5966
}
6067
}
6168

6269
const classTemplate = loadTemplate('class')
63-
classes.forEach(className => {
64-
const fileName = `docs/code/classes/${className}.md`
70+
classes.forEach(classInfo => {
71+
const fileName = `docs/code/classes/${classInfo.name}.md`
6572
const classData = templateData
66-
.filter(jsdocBlock => jsdocBlock.memberof === className)
73+
.filter(jsdocBlock => jsdocBlock.memberof === classInfo.name)
6774
.sort((a, b) => {
6875
return a.order < b.order ? -1 : 1
6976
})
7077

7178
classData.forEach(classData => {
7279
if (classData.kind === 'class') {
73-
classIndexData.classes[className].description = classData.description
80+
classIndexData.classes[classInfo.name].description = classData.description
7481
}
7582
})
7683

77-
console.log(`rendering ${className} to ${fileName}`)
78-
const context = { className, classData }
84+
console.log(`rendering ${classInfo.name} to ${fileName}`)
85+
const context = { className: classInfo.name, classData }
7986
fs.writeFileSync(fileName, classTemplate(context))
8087
})
8188

docs/code/classes/Builder.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

0 commit comments

Comments
 (0)