docs: Change API docs template to jsdoc-clean-theme (#8519)

This commit is contained in:
Lucas Coratger
2023-04-29 16:53:54 +02:00
committed by GitHub
parent 177891ea0e
commit 9e43bc2fa0
17 changed files with 393 additions and 79 deletions

View File

@@ -1,10 +1,16 @@
{
"plugins": ["node_modules/jsdoc-babel", "plugins/markdown"],
"babel": {
"plugins": ["@babel/plugin-transform-flow-strip-types"]
"plugins": ["@babel/plugin-transform-flow-strip-types"]
},
"source": {
"include": ["./README.md", "./src/cloud-code", "./src/Options/docs.js", "./src/ParseServer.js", "./src/Adapters"],
"include": [
"README.md",
"./src/cloud-code",
"./src/Options/docs.js",
"./src/ParseServer.js",
"./src/Adapters"
],
"excludePattern": "(^|\\/|\\\\)_"
},
"templates": {
@@ -17,7 +23,18 @@
"monospaceLinks": false
},
"opts": {
"template": "node_modules/@parse/minami",
"recurse": true
"encoding": "utf8",
"readme": "./README.md",
"recurse": true,
"template": "./node_modules/clean-jsdoc-theme",
"theme_opts": {
"default_theme": "dark",
"title": "<img src='../.github/parse-server-logo.png' class='logo'/>",
"create_style": "header, .sidebar-section-title, .sidebar-title { color: #139cee !important } .logo { margin-left : 40px; margin-right: 40px }"
}
},
"markdown": {
"hardwrap": false,
"idInHeadings": true
}
}
}