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: remove TOC in main page (#12270)

Browse Source
This commit is contained in:
Nikolay Vitkov 2024-04-15 08:23:56 +02:00 committed by GitHub
parent 140f012b51
commit 5116a33d2c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 22 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Herebyfile.mjs
View File

@ -6,20 +6,20 @@
/* eslint-disable import/order */
import {copyFile, readFile, writeFile} from 'fs/promises';
import {readFile, writeFile} from 'fs/promises';
import {docgen, spliceIntoSection} from '@puppeteer/docgen';
import {execa} from 'execa';
import {task} from 'hereby';
import semver from 'semver';
export const docsNgSchematicsTask = task({
name: 'docs:ng-schematics',
run: async () => {
const readme = await readFile('packages/ng-schematics/README.md', 'utf-8');
await writeFile('docs/guides/ng-schematics.md', readme);
},
});
function addNoTocHeader(markdown) {
return `---
hide_table_of_contents: true
---
${markdown}`;
}
/**
* This logic should match the one in `website/docusaurus.config.js`.
@ -34,6 +34,14 @@ function getApiUrl(version) {
}
}
export const docsNgSchematicsTask = task({
name: 'docs:ng-schematics',
run: async () => {
const readme = await readFile('packages/ng-schematics/README.md', 'utf-8');
await writeFile('docs/guides/ng-schematics.md', readme);
},
});
export const docsChromiumSupportTask = task({
name: 'docs:supported-browsers',
run: async () => {
@ -72,7 +80,8 @@ export const docsTask = task({
dependencies: [docsNgSchematicsTask, docsChromiumSupportTask],
run: async () => {
// Copy main page.
await copyFile('README.md', 'docs/index.md');
const mainPage = await readFile('README.md', 'utf-8');
await writeFile('docs/index.md', addNoTocHeader(mainPage));
// Generate documentation
for (const [name, folder] of [

4
docs/index.md
View File

@ -1,3 +1,7 @@
---
hide_table_of_contents: true
---
# Puppeteer
[![build](https://github.com/puppeteer/puppeteer/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/puppeteer/puppeteer/actions/workflows/ci.yml)