Skip to content

Commit 2dc1629

Browse files
authored
docs: improve sitemap configuration and table formatting (#79)
- Add sitemap plugin with custom configuration for better SEO - Set home page priority to 1.0 in sitemap - Simplify client compatibility table formatting - Remove footnote references for cleaner presentation
1 parent 25ae949 commit 2dc1629

4 files changed

Lines changed: 33 additions & 11 deletions

File tree

docs/docs/client-integration.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ Learn how to connect various MCP clients to your authenticated MCP server.
1010

1111
MCP Auth Proxy has been verified to work with all major MCP clients:
1212

13-
| MCP Client | Status | Notes |
14-
| ----------------- | ------ | ----------------------------------------------- |
15-
| Claude (Web) || Full compatibility |
16-
| Claude (Desktop) || Full compatibility |
17-
| Claude Code || Full compatibility |
18-
| ChatGPT (Web) || Requires `search` and `fetch` tools [¹](#notes) |
19-
| ChatGPT (Desktop) || Requires `search` and `fetch` tools [¹](#notes) |
20-
| GitHub Copilot || Full compatibility |
21-
| Cursor || Full compatibility |
13+
| MCP Client | Status | Notes |
14+
| ----------------- | ------ | ----------------------------------- |
15+
| Claude (Web) || Full compatibility |
16+
| Claude (Desktop) || Full compatibility |
17+
| Claude Code || Full compatibility |
18+
| ChatGPT (Web) || Requires `search` and `fetch` tools |
19+
| ChatGPT (Desktop) || Requires `search` and `fetch` tools |
20+
| GitHub Copilot || Full compatibility |
21+
| Cursor || Full compatibility |
2222

2323
## Claude Integration
2424

docs/docusaurus.config.ts

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ import { themes as prismThemes } from "prism-react-renderer";
22
import type { Config } from "@docusaurus/types";
33
import type * as Preset from "@docusaurus/preset-classic";
44

5+
const url = "https://sigbit.github.io";
6+
const baseUrl = "/mcp-auth-proxy/";
7+
58
const config: Config = {
69
title: "MCP Auth Proxy",
710
tagline: "Secure your MCP server with OAuth 2.1 — in a minute",
@@ -12,8 +15,8 @@ const config: Config = {
1215
v4: true, // Improve compatibility with the upcoming Docusaurus v4
1316
},
1417

15-
url: "https://sigbit.github.io",
16-
baseUrl: "/mcp-auth-proxy/",
18+
url,
19+
baseUrl,
1720

1821
organizationName: "sigbit",
1922
projectName: "mcp-auth-proxy",
@@ -38,6 +41,23 @@ const config: Config = {
3841
theme: {
3942
customCss: "./src/css/custom.css",
4043
},
44+
sitemap: {
45+
lastmod: "date",
46+
changefreq: "weekly",
47+
priority: 0.5,
48+
ignorePatterns: ["/tags/**"],
49+
filename: "sitemap.xml",
50+
createSitemapItems: async (params) => {
51+
const { defaultCreateSitemapItems, ...rest } = params;
52+
const items = await defaultCreateSitemapItems(rest);
53+
return items.map((item) => {
54+
if (item.url === `${url}${baseUrl}`) {
55+
return { ...item, priority: 1.0 };
56+
}
57+
return item;
58+
});
59+
},
60+
},
4161
} satisfies Preset.Options,
4262
],
4363
],

docs/package-lock.json

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
},
1818
"dependencies": {
1919
"@docusaurus/core": "3.8.1",
20+
"@docusaurus/plugin-sitemap": "^3.8.1",
2021
"@docusaurus/preset-classic": "3.8.1",
2122
"@mdx-js/react": "^3.0.0",
2223
"clsx": "^2.0.0",

0 commit comments

Comments
 (0)