Skip to content

Advertise .md companion in doc page <head>#451

Open
jerrinot wants to merge 2 commits into
mainfrom
jh_markdown_alternative
Open

Advertise .md companion in doc page <head>#451
jerrinot wants to merge 2 commits into
mainfrom
jh_markdown_alternative

Conversation

@jerrinot
Copy link
Copy Markdown
Contributor

Inject into every generated doc HTML so HTML-parsing agents can discover the markdown form without sniffing URL patterns. Adds X-Robots-Tag: noindex to .md responses so the raw markdown doesn't show up as duplicate content in Google. Extracts a shared getMarkdownUrl() helper used by both the postBuild plugin and the existing CopyPageButton, so the URL convention has a single source of truth.

Inject <link rel="alternate" type="text/markdown" href="..."> into every
generated doc HTML so HTML-parsing agents can discover the markdown form
without sniffing URL patterns. Adds X-Robots-Tag: noindex to .md responses
so the raw markdown doesn't show up as duplicate content in Google.
Extracts a shared getMarkdownUrl() helper used by both the postBuild
plugin and the existing CopyPageButton, so the URL convention has a
single source of truth.
@jerrinot jerrinot added the documentation Improvements or additions to documentation label May 18, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 18, 2026

🤖 Component Converter Reminder

A component in src/components/ or src/theme/ was modified in this pull request.

We are creating markdown correspondents of every path (e.g. questdb.com/docs/quick-start/ → questdb.com/docs/quick-start.md) for LLM consumption.
If the component usage is shadowing useful content, it may need a converter for markdown output in convert-components.js.

Quick Check

  • Content component (code, tables, data) → Add converter if not exists
  • UI/visual component (styling, buttons, decorative) → No converter needed

💡 This is a friendly reminder, not a blocker. Ignore if not applicable.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 18, 2026

🚀 Build success!

Latest successful preview: https://preview-451--questdb-documentation.netlify.app/docs/

Commit SHA: 3c4cd69

📦 Build generates a preview & updates link on each commit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants