Glossary: modifications to glossary system

[Blargian]

Summary

Some small improvements:

• Expand to work with .md or .mdx
• Don't wrap terminology which is in headers (e.g. ## What are parts should not become ## What are ^^Parts^^
• Don't run the processor on every file in the docs, only on the folders which we ran wrap-glossary-terms.py on
• Fix README.md
• Remove ^^ ^^ from some parts of the docs which don't need to be wrapped (Let's begin with core-concepts, quick-starts), we can expand in future.

Future improvements:

• If a page contains x amount of glossary terms, only mark one per paragraph. I.e

This is a made up paragraph about ^^parts^^, which contains a lot of references to ^^parts^^. I mean like really a lot of references to ^^parts^^. So many ^^parts^^. All the ^^parts^^. ClickHouse has the best ^^parts^^.

could just be

This is a made up paragraph about ^^parts^^, which contains a lot of references to parts. I mean like really a lot of references to parts. So many parts. All the parts. ClickHouse has the best parts.

We'll need to add a preprocessing step to remove ^^ ^^ before translating, or figure out a way to make this multilingual.

Checklist

• Delete items not relevant to your PR
• URL changes should add a redirect to the old URL via https://github.com/ClickHouse/clickhouse-docs/blob/main/docusaurus.config.js
• If adding a new integration page, also add an entry to the integrations list here: https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/integrations/index.mdx

[vercel]

@Blargian is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Updated (UTC)
clickhouse-docs	Ready	Preview	Aug 28, 2025 7:08pm

[Blargian]

@dhtclk correct me if i'm wrong but I don't see why this won't work on .md files?

[dhtclk]

on build time, the plugin would look for "^^ ^^" but it would only work properly on mdx files because it's injecting our custom react components, which aren't parsed properly by md files because they can't parse JSX, only standard markdown syntax.

[Blargian]

We seem to be processing all the files when only a small portion have ^^ ^^ so let's just do a subset. We can add as we go along.

[dhtclk]

we'll just have to adjust the glossary-transformer so that it only processes mdx files.

UPDATE: nevermind I was wrong :D

[Blargian]

we'll just have to adjust the glossary-transformer so that it only processes mdx files.

Oh ye of little faith :-) I pushed a commit to rename parts.mdx to parts.md. The transformation is just from a custom ^^ ^^ syntax to an HTML-like one (it's not even valid React because we're not importing the component into the file). Docusaurus is transforming both .md and .mdx to HTML at the end of the day, so from Reacts point of view it works.

Processed 28 glossary terms in: merges.mdx
Processed 13 glossary terms in: parts.md <--- 
Processed 19 glossary terms in: primary-indexes.mdx

https://clickhouse-docs-f4wde8985-clickhouse.vercel.app/docs/parts#part-merges