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

fix: add script to remove html comments from docs markdown (#7394)

Browse Source
This commit is contained in:
TASNEEM KOUSHAR 2021-07-06 15:25:42 +05:30 committed by GitHub
parent b5e6474374
commit ea3df80ed1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
package.json
View File

@ -37,7 +37,7 @@
"test-install": "scripts/test-install.sh",
"clean-docs": "rimraf new-docs && rimraf docs-api-json",
"generate-d-ts": "npm run clean-docs && api-extractor run --local --verbose",
"generate-docs": "npm run generate-d-ts && api-documenter markdown -i docs-api-json -o new-docs",
"generate-docs": "npm run generate-d-ts && api-documenter markdown -i docs-api-json -o new-docs && node utils/remove-tag.js",
"ensure-correct-devtools-protocol-revision": "ts-node -s scripts/ensure-correct-devtools-protocol-package",
"ensure-pinned-deps": "ts-node -s scripts/ensure-pinned-deps",
"test-types-file": "ts-node -s scripts/test-ts-definition-files.ts",

32
utils/remove-tag.js Normal file
View File

@ -0,0 +1,32 @@
#!/usr/bin/env node
/**
* Copyright 2018 Google Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Docusaurus gets confused by empty HTML comment tags in our Markdown.
These are generated by API Extractor but do not affect the final output,
so to avoid Docusaurus errors we strip them out before generating the website.
**/
const glob = require('glob');
const fs = require('fs');
// look for all .md files in the given location.
const files = glob.sync(`./new-docs/*.md`);
for (const file of files) {
const content = fs.readFileSync(file, 'utf8');
const updated = content.replace(/<!-- -->/g, '');
fs.writeFileSync(file, updated);
}