fix: cleanup docs more

This commit is contained in:
Skillz
2023-02-24 23:54:01 -06:00
parent bd3a9d60c1
commit 63a0b381bc
12 changed files with 86 additions and 48 deletions
+3 -3
View File
@@ -18,9 +18,9 @@ site/docs/generated/enums
site/docs/generated/interfaces
site/docs/generated/modules
website/docs/generated/classes
website/docs/generated/enums
website/docs/generated/interfaces
website/docs/generated/modules
website/docs/generated/enums/*.md
website/docs/generated/interfaces/*.md
website/docs/generated/modules/*.md
website/.yarn/
# testing
coverage
+40
View File
@@ -0,0 +1,40 @@
import fs from 'node:fs'
import path from 'node:path'
// these two paths may vary depending on where you place this script, and your project structure including where typedoc generates its output files.
const typedocOutPath = await import('../typedoc.json', {
assert: { type: 'json' },
}).then((module) => module.default.out)
async function* walk(dir) {
for await (const d of await fs.promises.opendir(dir)) {
const entry = path.join(dir, d.name)
if (d.isDirectory()) yield* walk(entry)
else if (d.isFile()) yield entry
}
}
for await (let filepath of walk(typedocOutPath)) {
let file = fs.readFileSync(filepath, 'utf-8')
// add all the words we need to replace here for invalid jsx errors
const words = ['internal']
for (const word of words) {
file = file.replace(new RegExp(`<${word}>`, 'gi'), word)
}
// Converts ugly names to clean names for example discordeno_types.ActionRow becomes ActionRow
const cleanForms = [{ ugly: 'discordeno_types.' }, { ugly: "discordeno_utils."}]
for (const form of cleanForms) {
// Clean the file of the ugly forms
file = file.replace(new RegExp(form.ugly, 'gi'), form.clean || '')
const lastIndex = filepath.lastIndexOf("/")
// Clean the file name of the ugly forms
filepath = filepath.replace(new RegExp(form.ugly, 'gi'), form.clean || '')
}
fs.writeFileSync(filepath, file, function (err, result) {
if (err) throw err
})
}
-28
View File
@@ -1,28 +0,0 @@
import fs from 'node:fs'
import path from 'node:path'
// these two paths may vary depending on where you place this script, and your project structure including where typedoc generates its output files.
const typedocOutPath = await import('../typedoc.json', {
assert: { type: 'json' },
}).then((module) => module.default.out)
async function* walk(dir) {
for await (const d of await fs.promises.opendir(dir)) {
const entry = path.join(dir, d.name);
if (d.isDirectory()) yield* walk(entry);
else if (d.isFile()) yield entry;
}
}
for await (const filepath of walk(typedocOutPath)) {
let file = fs.readFileSync(filepath, 'utf-8')
// add all the words we need to replace here for invalid jsx errors
const words = ["internal"];
for (const word of words) {
file = file.replace(new RegExp(`<${word}>`, 'gi'), word);
}
fs.writeFileSync(filepath, file, function (err, result) { if (err) throw err });
}
+1 -1
View File
@@ -1,6 +1,6 @@
{
"label": "Big Bot Guide",
"position": 2,
"position": 3,
"link": {
"type": "generated-index",
"description": "Learn the most important concepts and set up a base template for your bot."
+5
View File
@@ -0,0 +1,5 @@
discordeno-monorepo / [Modules](modules.md)
# Discordeno
how to make this not reset?
-5
View File
@@ -1,5 +0,0 @@
discordeno-monorepo / [Modules](modules.md)
# Discordeno
This documentation was generated automatically. If you see any mistakes, please contact us on discord/github.
+9
View File
@@ -0,0 +1,9 @@
{
"label": "Docs",
"position": 2,
"link": {
"type": "generated-index",
"description": "If you need any help, please contact us on [Discord](https://discord.gg/ddeno)."
}
}
@@ -0,0 +1,9 @@
{
"label": "Enums",
"position": 1,
"link": {
"type": "generated-index",
"description": "All the enums available for use from the @discordeno/types package."
}
}
@@ -0,0 +1,9 @@
{
"label": "Interfaces",
"position": 2,
"link": {
"type": "generated-index",
"description": "All the interfaces available for use from the @discordeno/types package."
}
}
-10
View File
@@ -1,10 +0,0 @@
[discordeno-monorepo](README.md) / Modules
# discordeno-monorepo
## Table of contents
### Modules
- [@discordeno/types](modules/discordeno_types.md)
- [@discordeno/utils](modules/discordeno_utils.md)
@@ -0,0 +1,9 @@
{
"label": "Modules",
"position": 3,
"link": {
"type": "generated-index",
"description": "All the modules(packages) available for use from @discordeno."
}
}
+1 -1
View File
@@ -1,6 +1,6 @@
{
"label": "Tutorial - Extras",
"position": 3,
"position": 4,
"link": {
"type": "generated-index"
}