docs: fix appending index.html.md to api reference links (#11327)
* docs: fix appending index.html.md to api reference links * make hash in api reference lower case
This commit is contained in:
1 parent
bc53716d8d
commit
a655b49a7d
6 files changed
+11314
-11218
No files matched your search
@@ -81,7 +81,8 @@ export const apiRefLlmsGenerator: CustomLlmsGenerator<
|
||||
|
||||
Object.entries(fileYaml).forEach(
|
||||
([httpMethod, operation]: [string, any]) => {
|
||||
const hash = `${slugify(operation.tags[0])}_${slugify(operation.operationId)}`
|
||||
const hash =
|
||||
`${slugify(operation.tags[0])}_${slugify(operation.operationId)}`.toLowerCase()
|
||||
|
||||
content += `- [${httpMethod.toUpperCase()} ${oasPath}](${options?.baseUrl}#${hash})\n`
|
||||
}
|
||||
|
||||
@@ -145,22 +145,6 @@ const removeFrontmatterPlugin = (): Transformer => {
|
||||
}
|
||||
}
|
||||
|
||||
const changeLinksPlugin = (): Transformer => {
|
||||
return async (tree) => {
|
||||
const { visit } = await import("unist-util-visit")
|
||||
|
||||
visit(tree as UnistTree, ["link"], (node: UnistNode) => {
|
||||
if (
|
||||
node.type === "link" &&
|
||||
node.url?.startsWith("https://docs.medusajs.com") &&
|
||||
!node.url.endsWith("index.html.md")
|
||||
) {
|
||||
node.url += `/index.html.md`
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
const getParsedAsString = (file: VFile): string => {
|
||||
let content = file.toString().replaceAll(/^([\s]*)\* /gm, "$1- ")
|
||||
const frontmatter = file.data.matter as FrontMatter | undefined
|
||||
@@ -214,8 +198,6 @@ export const getCleanMd = async ({
|
||||
unifier.use(...(Array.isArray(plugin) ? plugin : [plugin]))
|
||||
})
|
||||
|
||||
unifier.use(changeLinksPlugin)
|
||||
|
||||
const content = type === "file" ? await read(file) : file
|
||||
const parsed = await unifier.process(content)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
import { UnistNode, UnistTree } from "types"
|
||||
import { Transformer } from "unified"
|
||||
|
||||
export const changeLinksToHtmlMdPlugin = (): Transformer => {
|
||||
return async (tree) => {
|
||||
const { visit } = await import("unist-util-visit")
|
||||
|
||||
visit(tree as UnistTree, ["link"], (node: UnistNode) => {
|
||||
if (
|
||||
node.type === "link" &&
|
||||
node.url?.startsWith("https://docs.medusajs.com") &&
|
||||
!node.url.endsWith("index.html.md")
|
||||
) {
|
||||
node.url += `/index.html.md`
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,6 @@
|
||||
export * from "./add-url-to-relative-link.js"
|
||||
export * from "./broken-link-checker.js"
|
||||
export * from "./change-links-md.js"
|
||||
export * from "./cloudinary-img.js"
|
||||
export * from "./cross-project-links.js"
|
||||
export * from "./local-links.js"
|
||||
|
||||
Reference in new issue
Block a user