fix: including readme files

This commit is contained in:
iCrawl
2022-11-29 01:06:02 +01:00
parent 1efa95337f
commit 6bcebd4867
6 changed files with 312 additions and 102 deletions

View File

@@ -21,6 +21,7 @@ typings/
build/
src/styles/unocss.css
.next/
src/assets/readme/
# Miscellaneous
.tmp/

View File

@@ -5,8 +5,9 @@
"private": true,
"scripts": {
"test": "vitest run",
"build:local": "yarn run --top-level docs --force && cross-env-shell NEXT_PUBLIC_LOCAL_DEV=true yarn build:prod",
"build:prod": "yarn workspaces foreach -ptR run build && yarn build:css && yarn build:next",
"build:copy_readme": "cpy '../../packages/*/README.md' 'src/assets/readme' --rename='home-{{basename}}'",
"build:local": "yarn run --top-level docs --force && yarn build:copy_readme && cross-env-shell NEXT_PUBLIC_LOCAL_DEV=true yarn build:prod",
"build:prod": "yarn workspaces foreach -ptR run build && yarn build:copy_readme && yarn build:css && yarn build:next",
"build:next": "next build",
"build:css": "yarn generate:css",
"build:search_indicies": "yarn node scripts/generateAllIndicies.js",
@@ -53,7 +54,7 @@
"ariakit": "^2.0.0-next.41",
"cmdk": "^0.1.20",
"meilisearch": "^0.30.0",
"next": "^13.0.5",
"next": "^13.0.6-canary.1",
"next-mdx-remote": "^4.2.0",
"next-progress": "^2.2.0",
"next-themes": "^0.2.1",
@@ -84,6 +85,7 @@
"@vitejs/plugin-react": "^2.2.0",
"@vitest/coverage-c8": "^0.25.3",
"concurrently": "^7.6.0",
"cpy-cli": "^4.2.0",
"cross-env": "^7.0.3",
"eslint": "^8.28.0",
"eslint-config-neon": "^0.1.40",

View File

@@ -82,13 +82,13 @@ export async function generateStaticParams() {
'packages',
packageName,
versions[idx] ?? 'main',
`${member.name}%3A${member.overloadIndex}%3A${member.kind}`,
`${member.name}:${member.overloadIndex}:${member.kind}`,
],
};
}
return {
slug: ['packages', packageName, versions[idx] ?? 'main', `${member.name}%3A${member.kind}`],
slug: ['packages', packageName, versions[idx] ?? 'main', `${member.name}:${member.kind}`],
};
}),
),
@@ -103,11 +103,11 @@ export async function generateStaticParams() {
...getMembers(pkg, 'main').map((member) => {
if (member.kind === ApiItemKind.Function && member.overloadIndex && member.overloadIndex > 1) {
return {
slug: ['packages', packageName, 'main', `${member.name}%3A${member.overloadIndex}%3A${member.kind}`],
slug: ['packages', packageName, 'main', `${member.name}:${member.overloadIndex}:${member.kind}`],
};
}
return { slug: ['packages', packageName, 'main', `${member.name}%3A${member.kind}`] };
return { slug: ['packages', packageName, 'main', `${member.name}:${member.kind}`] };
}),
];
} catch {
@@ -127,7 +127,7 @@ async function getData(slug: string[]) {
const [memberName, overloadIndex] = member?.split('%3A') ?? [];
const readme = await readFile(join(cwd(), '..', '..', 'packages', packageName, 'README.md'), 'utf8');
const readme = await readFile(join(cwd(), 'src', 'assets', 'readme', packageName, 'home-README.md'), 'utf8');
const mdxSource = await serialize(readme, {
mdxOptions: {

View File

@@ -1,13 +0,0 @@
import { join } from 'node:path';
// eslint-disable-next-line n/prefer-global/process
import { cwd } from 'node:process';
join(cwd(), '..', '..', 'packages', 'brokers', 'README.md');
join(cwd(), '..', '..', 'packages', 'builders', 'README.md');
join(cwd(), '..', '..', 'packages', 'collection', 'README.md');
join(cwd(), '..', '..', 'packages', 'core', 'README.md');
join(cwd(), '..', '..', 'packages', 'proxy', 'README.md');
join(cwd(), '..', '..', 'packages', 'rest', 'README.md');
join(cwd(), '..', '..', 'packages', 'util', 'README.md');
join(cwd(), '..', '..', 'packages', 'voice', 'README.md');
join(cwd(), '..', '..', 'packages', 'ws', 'README.md');

View File

@@ -1,6 +0,0 @@
import type { NextApiRequest, NextApiResponse } from 'next';
import './_readme';
export default function handler(_: NextApiRequest, res: NextApiResponse) {
res.status(200).json({ _: '' });
}