mirror of
https://github.com/classchartsapi/classcharts-api-js.git
synced 2026-05-14 19:59:37 +00:00
feat: better documentation
This commit is contained in:
parent
58c5dfa1e4
commit
3aa119a063
12 changed files with 141 additions and 44 deletions
17
typedoc.config.cjs
Normal file
17
typedoc.config.cjs
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
/** @type {import('typedoc').TypeDocOptions} */
|
||||
module.exports = {
|
||||
entryPointStrategy: "resolve",
|
||||
entryPoints: [
|
||||
"src/studentClient.ts",
|
||||
"src/parentClient.ts",
|
||||
"src/baseClient.ts",
|
||||
"src/types.ts",
|
||||
],
|
||||
navigationLinks: {
|
||||
Discord: "https://discord.gg/DTcwugcgZ2",
|
||||
Github: "https://github.com/classchartsapi/classcharts-api-js",
|
||||
},
|
||||
includeVersion: true,
|
||||
out: "docs",
|
||||
sort: "required-first",
|
||||
};
|
||||
Loading…
Add table
Add a link
Reference in a new issue