diff --git a/package.json b/package.json index 4c8d635470dd5..0bdb101bc1d17 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/utils/remove-tag.js b/utils/remove-tag.js new file mode 100644 index 0000000000000..8e29117ba0461 --- /dev/null +++ b/utils/remove-tag.js @@ -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); +}