-
Notifications
You must be signed in to change notification settings - Fork 9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: add script to remove html comments from docs markdown (#7394)
- Loading branch information
1 parent
b5e6474
commit ea3df80
Showing
2 changed files
with
33 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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); | ||
} |