Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use parseMarkdownFile instead of parseMarkdownString #277

Merged
merged 3 commits into from
Jan 8, 2024
Merged

Use parseMarkdownFile instead of parseMarkdownString #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cf8757
Use parseMarkdownFile instead of parseMarkdownString
andremartinssw Jan 6, 2024
eda7dd3
Update yarn.lock
andremartinssw Jan 6, 2024
3176b41
Merge with main
andremartinssw Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions packages/docusaurus-plugin-openapi/src/docs/docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ import type { LoadContext } from "@docusaurus/types";
import {
aliasedSitePath,
normalizeUrl,
parseMarkdownString,
parseMarkdownFile,
DEFAULT_PARSE_FRONT_MATTER,
} from "@docusaurus/utils";

import { validateDocFrontMatter } from "./frontMatter";
Expand Down Expand Up @@ -78,11 +79,16 @@ async function doProcessDocMetadata({
const { siteDir } = context;

const {
frontMatter: unsafeFrontMatter,
contentTitle,
excerpt,
} = parseMarkdownString(content);
const frontMatter = validateDocFrontMatter(unsafeFrontMatter);
frontMatter: parsedFrontMatter,
contentTitle: parsedContentTitle,
excerpt: parsedExcerpt,
} = await parseMarkdownFile({
fileContent: content,
filePath,
parseFrontMatter: DEFAULT_PARSE_FRONT_MATTER,
});

const frontMatter = validateDocFrontMatter(parsedFrontMatter);

// E.g. api/plugins/myDoc -> myDoc; myDoc -> myDoc
const sourceFileNameWithoutExtension = path.basename(
Expand Down Expand Up @@ -129,9 +135,9 @@ async function doProcessDocMetadata({
// Note: the title is used by default for page title, sidebar label,
// pagination buttons... frontMatter.title should be used in priority over
// contentTitle (because it can contain markdown/JSX syntax)
const title: string = frontMatter.title ?? contentTitle ?? baseID;
const title: string = frontMatter.title ?? parsedContentTitle ?? baseID;

const description: string = frontMatter.description ?? excerpt ?? "";
const description: string = frontMatter.description ?? parsedExcerpt ?? "";

const permalink = normalizeUrl([
context.baseUrl,
Expand Down
Loading
Loading