Skip to content

fix: align markdown metadata base URLs #224

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

Closed
Kinfe123 wants to merge 1 commit into from
Closed

fix: align markdown metadata base URLs #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions packages/astro/src/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -861,6 +861,7 @@ export function createDocsServer(config: Record<string, any> = {}): DocsServer {
| undefined;

const llmsBaseUrl = typeof llmsTxtConfig === "object" ? (llmsTxtConfig.baseUrl ?? "") : "";
const markdownMetadataBaseUrl = resolveDocsMetadataBaseUrl(config as any);
const llmsTitle =
typeof llmsTxtConfig === "object" ? (llmsTxtConfig.siteTitle ?? llmsSiteTitle) : llmsSiteTitle;
const llmsDesc = typeof llmsTxtConfig === "object" ? llmsTxtConfig.siteDescription : undefined;
Expand Down Expand Up @@ -1099,11 +1100,11 @@ export function createDocsServer(config: Record<string, any> = {}): DocsServer {

const markdownRequest = resolveDocsMarkdownRequest(entry, url, context.request);
if (markdownRequest) {
const markdownOrigin = llmsBaseUrl || url.origin;
const markdownOrigin = markdownMetadataBaseUrl || url.origin;
const document = getMarkdownDocument(ctx, markdownRequest.requestedPath, markdownOrigin);
const varyHeader = getDocsMarkdownVaryHeader(context.request);
const canonicalLinkHeader = getDocsMarkdownCanonicalLinkHeader({
origin: url.origin,
origin: markdownOrigin,
entry,
requestedPath: markdownRequest.requestedPath,
locale: ctx.locale,
Expand Down
14 changes: 5 additions & 9 deletions packages/docs/src/agent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1499,10 +1499,6 @@ function appendDocsMarkdownSitemapFooter(
return `${markdown.replace(/\s+$/g, "")}\n\n${renderDocsMarkdownSitemapFooter(sitemap)}\n`;
}

function toDocsMarkdownYamlString(value: string): string {
return JSON.stringify(value);
}

function normalizeDocsMarkdownLastUpdated(value?: string): string | undefined {
if (!value) return undefined;
const trimmed = value.trim();
Expand Down Expand Up @@ -1538,11 +1534,11 @@ function renderDocsMarkdownFrontmatter({
}): string {
const lines = [
"---",
`title: ${toDocsMarkdownYamlString(title)}`,
...(description ? [`description: ${toDocsMarkdownYamlString(description)}`] : []),
`canonical_url: ${toDocsMarkdownYamlString(canonicalUrl)}`,
`markdown_url: ${toDocsMarkdownYamlString(markdownUrl)}`,
...(lastUpdated ? [`last_updated: ${toDocsMarkdownYamlString(lastUpdated)}`] : []),
`title: ${toYamlString(title)}`,
...(description ? [`description: ${toYamlString(description)}`] : []),
`canonical_url: ${toYamlString(canonicalUrl)}`,
`markdown_url: ${toYamlString(markdownUrl)}`,
...(lastUpdated ? [`last_updated: ${toYamlString(lastUpdated)}`] : []),
"---",
];

Expand Down
19 changes: 19 additions & 0 deletions packages/fumadocs/src/docs-api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1042,6 +1042,25 @@ Config content.
);
expect(fallbackDocument).not.toContain("<Agent>");

const { GET: getWithSitemapBaseUrl } = createDocsAPI({
rootDir,
entry: "docs",
sitemap: { enabled: true, baseUrl: "https://docs.example.com" },
});
const sitemapBaseUrlResponse = await getWithSitemapBaseUrl(
new Request("http://localhost/api/docs?format=markdown&path=getting-started/quickstart"),
);
expect(sitemapBaseUrlResponse.headers.get("link")).toBe(
'<https://docs.example.com/docs/getting-started/quickstart>; rel="canonical"',
);
const sitemapBaseUrlDocument = await sitemapBaseUrlResponse.text();
expect(sitemapBaseUrlDocument).toContain(
'canonical_url: "https://docs.example.com/docs/getting-started/quickstart"',
);
expect(sitemapBaseUrlDocument).toContain(
'markdown_url: "https://docs.example.com/docs/getting-started/quickstart.md"',
);

const { GET: getWithLlmsDisabled } = createDocsAPI({
rootDir,
entry: "docs",
Expand Down
13 changes: 11 additions & 2 deletions packages/fumadocs/src/docs-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import {
getDocsLlmsTxtMaxCharsIssue,
renderDocsMarkdownNotFound,
renderDocsMarkdownDocument,
resolveDocsMetadataBaseUrl,
resolveDocsMarkdownRecovery,
renderDocsLlmsTxt,
resolveDocsI18n,
Expand Down Expand Up @@ -3000,6 +3001,14 @@ export function createDocsAPI(options?: DocsAPIOptions) {
const llmsConfig = resolveLlmsTxtConfig(options?.llmsTxt, readLlmsTxtConfig(root));
const sitemapConfig = options?.sitemap ?? readSitemapConfig(root);
const robotsConfig = options?.robots ?? readRobotsConfig(root);
const markdownMetadataBaseUrl = resolveDocsMetadataBaseUrl({
...options,
entry,
ai: aiConfig,
llmsTxt: llmsConfig,
sitemap: sitemapConfig,
robots: robotsConfig,
} as DocsConfig);
const apiReferenceConfig = options?.apiReference ?? readApiReferenceConfig(root);
const apiReferenceDocsConfig = {
...options,
Expand Down Expand Up @@ -3413,15 +3422,15 @@ export function createDocsAPI(options?: DocsAPIOptions) {
resolvePublicMarkdownRequest(entry, docsPath, url, request);

if (markdownRequest) {
const markdownOrigin = llmsConfig.baseUrl || url.origin;
const markdownOrigin = markdownMetadataBaseUrl || url.origin;
const document = await getMarkdownDocument(
ctx,
markdownRequest.requestedPath,
markdownOrigin,
);
const varyHeader = getDocsMarkdownVaryHeader(request);
const canonicalLinkHeader = getPublicMarkdownCanonicalLinkHeader({
origin: url.origin,
origin: markdownOrigin,
ctx,
requestedPath: markdownRequest.requestedPath,
});
Expand Down
5 changes: 3 additions & 2 deletions packages/nuxt/src/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -851,6 +851,7 @@ export function createDocsServer(config: Record<string, any> = {}): DocsServer {
| undefined;

const llmsBaseUrl = typeof llmsTxtConfig === "object" ? (llmsTxtConfig.baseUrl ?? "") : "";
const markdownMetadataBaseUrl = resolveDocsMetadataBaseUrl(config as any);
const llmsTitle =
typeof llmsTxtConfig === "object" ? (llmsTxtConfig.siteTitle ?? llmsSiteTitle) : llmsSiteTitle;
const llmsDesc = typeof llmsTxtConfig === "object" ? llmsTxtConfig.siteDescription : undefined;
Expand Down Expand Up @@ -1089,11 +1090,11 @@ export function createDocsServer(config: Record<string, any> = {}): DocsServer {

const markdownRequest = resolveDocsMarkdownRequest(entry, url, context.request);
if (markdownRequest) {
const markdownOrigin = llmsBaseUrl || url.origin;
const markdownOrigin = markdownMetadataBaseUrl || url.origin;
const document = getMarkdownDocument(ctx, markdownRequest.requestedPath, markdownOrigin);
const varyHeader = getDocsMarkdownVaryHeader(context.request);
const canonicalLinkHeader = getDocsMarkdownCanonicalLinkHeader({
origin: url.origin,
origin: markdownOrigin,
entry,
requestedPath: markdownRequest.requestedPath,
locale: ctx.locale,
Expand Down
5 changes: 3 additions & 2 deletions packages/svelte/src/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -870,6 +870,7 @@ export function createDocsServer(config: Record<string, any> = {}): DocsServer {
| undefined;

const llmsBaseUrl = typeof llmsTxtConfig === "object" ? (llmsTxtConfig.baseUrl ?? "") : "";
const markdownMetadataBaseUrl = resolveDocsMetadataBaseUrl(config as any);
const llmsTitle =
typeof llmsTxtConfig === "object" ? (llmsTxtConfig.siteTitle ?? llmsSiteTitle) : llmsSiteTitle;
const llmsDesc = typeof llmsTxtConfig === "object" ? llmsTxtConfig.siteDescription : undefined;
Expand Down Expand Up @@ -1107,11 +1108,11 @@ export function createDocsServer(config: Record<string, any> = {}): DocsServer {

const markdownRequest = resolveDocsMarkdownRequest(entry, event.url, event.request);
if (markdownRequest) {
const markdownOrigin = llmsBaseUrl || event.url.origin;
const markdownOrigin = markdownMetadataBaseUrl || event.url.origin;
const document = getMarkdownDocument(ctx, markdownRequest.requestedPath, markdownOrigin);
const varyHeader = getDocsMarkdownVaryHeader(event.request);
const canonicalLinkHeader = getDocsMarkdownCanonicalLinkHeader({
origin: event.url.origin,
origin: markdownOrigin,
entry,
requestedPath: markdownRequest.requestedPath,
locale: ctx.locale,
Expand Down
5 changes: 3 additions & 2 deletions packages/tanstack-start/src/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -829,6 +829,7 @@ export function createDocsServer(config: Record<string, any>): DocsServer {
| undefined;

const llmsBaseUrl = typeof llmsTxtConfig === "object" ? (llmsTxtConfig.baseUrl ?? "") : "";
const markdownMetadataBaseUrl = resolveDocsMetadataBaseUrl(config as any);
const llmsTitle =
typeof llmsTxtConfig === "object" ? (llmsTxtConfig.siteTitle ?? llmsSiteTitle) : llmsSiteTitle;
const llmsDesc = typeof llmsTxtConfig === "object" ? llmsTxtConfig.siteDescription : undefined;
Expand Down Expand Up @@ -1059,11 +1060,11 @@ export function createDocsServer(config: Record<string, any>): DocsServer {

const markdownRequest = resolveDocsMarkdownRequest(entry, url, event.request);
if (markdownRequest) {
const markdownOrigin = llmsBaseUrl || url.origin;
const markdownOrigin = markdownMetadataBaseUrl || url.origin;
const document = getMarkdownDocument(ctx, markdownRequest.requestedPath, markdownOrigin);
const varyHeader = getDocsMarkdownVaryHeader(event.request);
const canonicalLinkHeader = getDocsMarkdownCanonicalLinkHeader({
origin: url.origin,
origin: markdownOrigin,
entry,
requestedPath: markdownRequest.requestedPath,
locale: ctx.locale,
Expand Down
Loading