-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into nic@review-dal-tutorial
- Loading branch information
Showing
9 changed files
with
209 additions
and
15 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
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 |
|---|---|---|
| @@ -1 +1 @@ | ||
| * @trilitech/developer-success | ||
| * @trilitech/techrel-docs |
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 |
|---|---|---|
|
|
@@ -7,3 +7,5 @@ node_modules | |
| out | ||
| build | ||
| _glossaryBuild | ||
| allPageSourceFiles.txt | ||
| allTutorials.txt | ||
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
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,147 @@ | ||
| import path from 'path'; | ||
| import fs from 'fs'; | ||
|
|
||
| import {remark} from 'remark' | ||
| import strip from 'strip-markdown'; | ||
|
|
||
| import { dirname } from 'node:path'; | ||
| import { fileURLToPath } from 'node:url'; | ||
|
|
||
| const __dirname = dirname(fileURLToPath(import.meta.url)); | ||
|
|
||
| import sidebars from '../../sidebars.js'; | ||
| // Map sidebars to output file names | ||
| const fileNames = { | ||
| documentationSidebar: 'allPageSourceFiles.txt', | ||
| tutorialsSidebar: 'allTutorials.txt', | ||
| } | ||
| const pathsToFilterOut = [ | ||
| 'overview/glossary', | ||
| ]; | ||
|
|
||
| // Given a docusaurus sidebar object, return a list of the local doc IDs in it | ||
| function getIdsRecursive(sidebarObject) { | ||
| if (typeof sidebarObject === 'string') { | ||
| return sidebarObject; | ||
| } | ||
| if (sidebarObject.constructor.name == "Array") { | ||
| return sidebarObject.reduce((list, oneSidebarObj) => | ||
| list.concat(getIdsRecursive(oneSidebarObj)), | ||
| []); | ||
| } | ||
| switch(sidebarObject.type) { | ||
| case 'category': | ||
| return [sidebarObject?.link?.id].concat(getIdsRecursive(sidebarObject.items)); | ||
| case 'doc': | ||
| return sidebarObject.id; | ||
| case 'link': | ||
| if (sidebarObject.href && sidebarObject.href.startsWith('http')) { | ||
| return null; | ||
| } else { | ||
| return sidebarObject.href; | ||
| } | ||
| default: | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| // Given a doc file ID from the sidebar, get the filename path | ||
| async function getFilePath(fileId) { | ||
| const mdPath = path.resolve(__dirname, '../../docs', fileId) + '.md'; | ||
| try { | ||
| await fs.promises.access(mdPath, fs.constants.F_OK); | ||
| return mdPath; | ||
| } catch { | ||
| // Do nothing | ||
| } | ||
| const mdxPath = mdPath + 'x'; | ||
| try { | ||
| await fs.promises.access(mdxPath, fs.constants.F_OK); | ||
| return mdxPath; | ||
| } catch { | ||
| console.error("Could not file file with sidebar ID", fileId); | ||
| } | ||
| } | ||
|
|
||
| // Remove the front matter from an MD file and replace with an H1 | ||
| // Got to remove FM because multiple FM blocks break some markdown tools | ||
| // Could do this with gray-matter but I don't want to add the dependency | ||
| function removeFrontMatter(mdText) { | ||
| const lines = mdText.split('\n'); | ||
| let inFrontMatter = false; | ||
| let doneWithFrontMatter = false; | ||
| const h1Regex = /^title:\s+(.*)$/; | ||
| let titleLine = ''; | ||
| let line = ''; | ||
|
|
||
| while (lines.length > 0) { | ||
| line = lines.shift(); | ||
| if (line == '---') { | ||
| doneWithFrontMatter = inFrontMatter; | ||
| inFrontMatter = true; | ||
| } | ||
| if (inFrontMatter && !doneWithFrontMatter && h1Regex.test(line)) { | ||
| const result = h1Regex.exec(line); | ||
| titleLine = '# ' + result[1]; | ||
| } | ||
| if (line != '---' && doneWithFrontMatter) { | ||
| return [titleLine, ''].concat(lines).join('\n'); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Unified tools put escapes in places | ||
| // We could get around this by forking mdast-util-to-string as described here: | ||
| // https://github.com/remarkjs/strip-markdown/issues/28#issuecomment-1290847745 | ||
| function cleanUpEscapes(text) { | ||
| return text | ||
| // Fix stripped markdown escaping such as `_` to `\_` | ||
| .replaceAll('\\\_', '_') | ||
| .replaceAll('\\<', '<') | ||
| .replaceAll('\\[', '[') | ||
| .replaceAll(/^\\-/gm, '-') | ||
| .replaceAll('\\.', '.') | ||
| .replaceAll('\\*', '*'); | ||
| } | ||
|
|
||
| async function concatSidebar(sidebarName) { | ||
| const outputPath = path.resolve(__dirname, '../../', fileNames[sidebarName]); | ||
|
|
||
| // Remove old concatenated file if it exists | ||
| try { | ||
| await fs.promises.access(outputPath, fs.constants.F_OK); | ||
| await fs.promises.unlink(outputPath); | ||
| } catch { | ||
| // Do nothing because the file does not exist | ||
| } | ||
|
|
||
| const allMdIds = getIdsRecursive(sidebars[sidebarName]) | ||
| .filter((id) => !pathsToFilterOut.includes(id)) | ||
| .filter((item) => item); | ||
|
|
||
| // Find the matching file paths | ||
| const allFilePaths = await Promise.all(allMdIds.map(getFilePath)); | ||
|
|
||
| // Read and concat the files in TOC order | ||
| await allFilePaths.reduce(async (previousPromise, oneFilePath) => { | ||
| await previousPromise; | ||
| const markdownText = removeFrontMatter(await fs.promises.readFile(oneFilePath, 'utf8')); | ||
| const oneFileText = await remark() | ||
| .use(strip) | ||
| .process(markdownText); | ||
| const oneFileTextFixEscaped = cleanUpEscapes(String(oneFileText)); | ||
| return fs.promises.appendFile(outputPath, oneFileTextFixEscaped + '\n\n'); | ||
| }, Promise.resolve()); | ||
|
|
||
| console.log(`Wrote concatenated file for sidebar ${sidebarName} to ${outputPath}`); | ||
| } | ||
|
|
||
| // Concatenate the sidebars listed in fileNames to separate single files | ||
| async function concatSidebars() { | ||
| const sidebarNames = Object.keys(sidebars); | ||
| await Promise.all(sidebarNames | ||
| .filter((oneSidebarName) => Object.keys(fileNames).includes(oneSidebarName)) | ||
| .map(concatSidebar)); | ||
| } | ||
|
|
||
| concatSidebars(); |