mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-11-29 08:19:34 +08:00
add basic api page
This commit is contained in:
parent
f1936e629a
commit
39b96e4244
@ -2,43 +2,63 @@ const path = require('path')
|
||||
const globby = require('globby')
|
||||
const TypeDoc = require('typedoc')
|
||||
|
||||
const packages = globby.sync('../packages/*', { onlyDirectories: true })
|
||||
.map(name => name.replace('../packages/', ''))
|
||||
.filter(name => name.startsWith('core'))
|
||||
.map(name => {
|
||||
const app = new TypeDoc.Application()
|
||||
|
||||
app.options.addReader(new TypeDoc.TSConfigReader())
|
||||
app.options.addReader(new TypeDoc.TypeDocReader())
|
||||
app.bootstrap({
|
||||
ignoreCompilerErrors: true,
|
||||
experimentalDecorators: true,
|
||||
excludeExternals: true,
|
||||
excludeNotExported: true,
|
||||
excludeProtected: true,
|
||||
excludePrivate: true,
|
||||
// excludeNotDocumented: true,
|
||||
exclude: [
|
||||
"**/*.test.ts",
|
||||
"**/__tests__/*",
|
||||
"**/__mocks__/*"
|
||||
],
|
||||
})
|
||||
|
||||
const project = app.convert(app.expandInputFiles([`../packages/${name}`]))
|
||||
|
||||
if (project) {
|
||||
// app.generateDocs(project, `api/${name}`)
|
||||
// app.generateJson(project, `api/${name}.json`)
|
||||
const json = app.serializer.projectToObject(project)
|
||||
return json
|
||||
}
|
||||
|
||||
return null
|
||||
})
|
||||
.filter(package => !!package)
|
||||
|
||||
module.exports = function (api) {
|
||||
|
||||
// api.loadSource(({ addCollection }) => {
|
||||
// const appCollection = addCollection({ typeName: 'Package' })
|
||||
api.loadSource(({ addCollection }) => {
|
||||
const appCollection = addCollection({ typeName: 'Package' })
|
||||
|
||||
// globby.sync('../packages/*', { onlyDirectories: true })
|
||||
// .map(name => name.replace('../packages/', ''))
|
||||
// .filter(name => name.startsWith('core'))
|
||||
// .forEach(name => {
|
||||
// const app = new TypeDoc.Application()
|
||||
packages.forEach(package => {
|
||||
appCollection.addNode(package)
|
||||
})
|
||||
})
|
||||
|
||||
// app.options.addReader(new TypeDoc.TSConfigReader())
|
||||
// app.options.addReader(new TypeDoc.TypeDocReader())
|
||||
// app.bootstrap({
|
||||
// ignoreCompilerErrors: true,
|
||||
// experimentalDecorators: true,
|
||||
// excludeExternals: true,
|
||||
// excludeNotExported: true,
|
||||
// excludeProtected: true,
|
||||
// excludePrivate: true,
|
||||
// // excludeNotDocumented: true,
|
||||
// exclude: [
|
||||
// "**/*.test.ts",
|
||||
// "**/__tests__/*",
|
||||
// "**/__mocks__/*"
|
||||
// ],
|
||||
// })
|
||||
|
||||
// const project = app.convert(app.expandInputFiles([`../packages/${name}`]))
|
||||
|
||||
// if (project) {
|
||||
// app.generateJson(project, `api/${name}.json`)
|
||||
// const json = app.serializer.projectToObject(project)
|
||||
// appCollection.addNode(json)
|
||||
// }
|
||||
// })
|
||||
// })
|
||||
api.createPages(({ createPage }) => {
|
||||
packages.forEach(package => {
|
||||
createPage({
|
||||
path: `/api/${package.name}`,
|
||||
component: './src/templates/ApiPage/index.vue',
|
||||
context: {
|
||||
package,
|
||||
},
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
api.chainWebpack(config => {
|
||||
config.resolve.extensions
|
||||
|
38
docs/src/templates/ApiPage/index.vue
Normal file
38
docs/src/templates/ApiPage/index.vue
Normal file
@ -0,0 +1,38 @@
|
||||
<template>
|
||||
<Layout>
|
||||
<div>
|
||||
<div v-for="(file, i) in this.package.children" :key="i">
|
||||
<h2>
|
||||
{{ file.name }}
|
||||
</h2>
|
||||
<div v-for="(bla, j) in file.children" :key="j">
|
||||
<template v-if="['Class', 'Method', 'Module'].includes(bla.kindString)">
|
||||
<h3>
|
||||
{{ bla.name }}
|
||||
</h3>
|
||||
</template>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</Layout>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
export default {
|
||||
// props: {
|
||||
// package: {
|
||||
// default: null,
|
||||
// type: Object
|
||||
// }
|
||||
// },
|
||||
|
||||
computed: {
|
||||
package() {
|
||||
console.log(this.$context.package)
|
||||
return this.$context.package
|
||||
},
|
||||
},
|
||||
}
|
||||
</script>
|
||||
|
||||
<style lang="scss" src="./style.scss" scoped></style>
|
0
docs/src/templates/ApiPage/style.scss
Normal file
0
docs/src/templates/ApiPage/style.scss
Normal file
Loading…
Reference in New Issue
Block a user