Skip to content

feat(config): add SEO headTags, metadata, and structured data #318

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

Merged
kmesh-bot merged 3 commits into from
Jul 4, 2026
Merged

feat(config): add SEO headTags, metadata, and structured data #318

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
dda5bfb
add metadata, OpenGraph, Twitter cards, and structured data to Docusa…
kunal-yelgate Jun 25, 2026
09b3297
fix: move image field to themeConfig to resolve build error
kunal-yelgate Jun 30, 2026
6a172ef
fix: implement PR review feedback for SEO metadata
kunal-yelgate Jun 30, 2026
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
63 changes: 63 additions & 0 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { themes as prismThemes } from "prism-react-renderer";
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Kmesh",
tagline: "High-performance sidecarless service mesh dataplane based on eBPF",
favicon: "img/favicons/favicon.ico",

// Set the production url of your site here
Expand All @@ -15,6 +16,28 @@ const config = {
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",

// ===== SEO: Head tags =====
headTags: [
{
tagName: "script",
attributes: {
type: "application/ld+json",
},
innerHTML: JSON.stringify({
"@context": "https://schema.org",
"@type": "Organization",
name: "Kmesh",
url: "https://kmesh.net",
logo: "https://kmesh.net/img/favicons/favicon.ico",
sameAs: [
"https://github.com/kmesh-net/kmesh",
"https://x.com/Kmesh_net",
"https://www.youtube.com/@Kmesh-traffic",
],
}),
},
],

onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",

Expand Down Expand Up @@ -72,12 +95,52 @@ const config = {
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
image: "img/kmesh-social-card.png",
docs: {
sidebar: {
hideable: true,
autoCollapseCategories: true,
},
},

// ===== SEO metadata =====
metadata: [
{
name: "description",
content:
"Kmesh is a high-performance, sidecarless service mesh dataplane based on eBPF and programmable kernel for cloud-native applications.",
},
{
property: "og:type",
content: "website",
},
{
property: "og:site_name",
content: "Kmesh",
},
{
name: "twitter:card",
content: "summary_large_image",
},
{
name: "twitter:site",
content: "@Kmesh_net",
},
{
name: "keywords",
content:
"Kmesh, service mesh, eBPF, dataplane, Kubernetes, sidecarless, cloud-native, CNCF, high-performance networking",
},
{
name: "author",
content: "Kmesh Community",
},
{
name: "robots",
content: "index, follow",
},
],
Comment on lines +107 to +142

@gemini-code-assist gemini-code-assist Bot Jun 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Move the global meta tags (description, og:type, og:site_name, twitter:card, and twitter:site) from headTags to themeConfig.metadata so that Docusaurus can manage them properly and allow page-specific overrides.

      metadata: [
        {
          name: "description",
          content:
            "Kmesh is a high-performance, sidecarless service mesh dataplane based on eBPF and programmable kernel for cloud-native applications.",
        },
        {
          property: "og:type",
          content: "website",
        },
        {
          property: "og:site_name",
          content: "Kmesh",
        },
        {
          name: "twitter:card",
          content: "summary_large_image",
        },
        {
          name: "twitter:site",
          content: "@Kmesh_net",
        },
        {
          name: "keywords",
          content:
            "Kmesh, service mesh, eBPF, dataplane, Kubernetes, sidecarless, cloud-native, CNCF, high-performance networking",
        },
        {
          name: "author",
          content: "Kmesh Community",
        },
        {
          name: "robots",
          content: "index, follow",
        },
      ],


navbar: {
title: "Kmesh",
logo: {
Expand Down
12 changes: 6 additions & 6 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2276,10 +2276,10 @@
dependencies:
"@types/mdx" "^2.0.0"

"@node-rs/jieba-darwin-arm64@2.0.1":
"@node-rs/jieba-win32-x64-msvc@2.0.1":
version "2.0.1"
resolved "https://registry.npmjs.org/@node-rs/jieba-darwin-arm64/-/jieba-darwin-arm64-2.0.1.tgz"
integrity sha512-10+nwGQ6KzXXJlIL/sELA6Fi6m7eJ7xJksBiKuw1kxKUgaJwtVfAG0iqRF+NRQv0Sdq7r3k5ew9K9y0+IYaEcA==
resolved "https://registry.npmjs.org/@node-rs/jieba-win32-x64-msvc/-/jieba-win32-x64-msvc-2.0.1.tgz"
integrity sha512-LDOyo2/2CO8UnpSGLJdgqtH8mOnsABPhNxkfIky7UT9cyLEzOaU44nbA5YzPGpBI3qzMbWcwJYQsjBcgK2VqAg==

"@node-rs/jieba@^2.0.1":
version "2.0.1"
Expand Down Expand Up @@ -2322,10 +2322,10 @@
"@nodelib/fs.scandir" "2.1.5"
fastq "^1.6.0"

"@parcel/watcher-darwin-arm64@2.5.1":
"@parcel/watcher-win32-x64@2.5.1":
version "2.5.1"
resolved "https://registry.npmjs.org/@parcel/watcher-darwin-arm64/-/watcher-darwin-arm64-2.5.1.tgz"
integrity sha512-eAzPv5osDmZyBhou8PoF4i6RQXAfeKL9tjb3QzYuccXFMQU0ruIc/POh30ePnaOyD1UXdlKguHBmsTs53tVoPw==
resolved "https://registry.npmjs.org/@parcel/watcher-win32-x64/-/watcher-win32-x64-2.5.1.tgz"
integrity sha512-9lHBdJITeNR++EvSQVUcaZoWupyHfXe1jZvGZ06O/5MflPcuPLtEphScIBL+AiCWBO46tDSHzWyD0uDmmZqsgA==

"@parcel/watcher@^2.4.1":
version "2.5.1"
Expand Down
Loading