github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add readme to the API reference index (#10001)

Browse Source
This commit is contained in:
Alex Rudenko
2023-04-11 14:47:25 +02:00
committed by GitHub
parent 1eca5663f1
commit dba1b2d9cc
3 changed files with 41 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
tools/generate_docs.ts
View File

@@ -119,7 +119,7 @@ function spliceIntoSection(
.outputs(['docs/api'])
.build();
job('', async ({inputs, outputs}) => {
await job('', async ({inputs, outputs}) => {
await rm(outputs[0]!, {recursive: true, force: true});
generateDocs(inputs[0]!, outputs[0]!);
spawnAndLog('prettier', '--ignore-path', 'none', '--write', 'docs');
@@ -130,4 +130,13 @@ function spliceIntoSection(
])
.outputs(['docs/browsers-api'])
.build();
job('', async ({inputs, outputs}) => {
const readme = await readFile(inputs[1]!, 'utf-8');
const index = await readFile(inputs[0]!, 'utf-8');
await writeFile(outputs[0]!, index.replace('# API Reference\n', readme));
})
.inputs(['docs/browsers-api/index.md', 'packages/browsers/README.md'])
.outputs(['docs/browsers-api/index.md'])
.build();
})();