Skip to content

Add raw Markdown access support (.md extension) in docs - #1464

Open
pierre-monnet wants to merge 7 commits into
datacontract:mainfrom
pierre-monnet:patch-4
Open

Add raw Markdown access support (.md extension) in docs#1464
pierre-monnet wants to merge 7 commits into
datacontract:mainfrom
pierre-monnet:patch-4

Conversation

@pierre-monnet

@pierre-monnet pierre-monnet commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Motivation & Context

This PR adds the docusaurus-markdown-source-plugin to our Docusaurus setup, allowing users and automated agents to fetch raw Markdown versions of any documentation page by appending .md to the page URL.

Why this matters:

  • LLM & AI Integration: Modern AI tools, agents, and IDE extensions (like Cursor, GitHub Copilot, or Custom GPTs) perform significantly better when consuming clean Markdown context directly rather than scraping rendered HTML.
  • Developer Experience: Allows developers to inspect, share, or fetch raw source files directly from the live documentation site without having to navigate through the source repository.
  • Modern Standards: Aligns our documentation experience with current developer tooling standards.

Dependency management:

Added docusaurus-markdown-source-plugin to the dependencies section in docs/package.json.

Configuration updates:

Registered 'docusaurus-markdown-source-plugin' in the plugins array of docs/docusaurus.config.ts to activate the plugin.

Check List

  • Tests pass (uv run pytest)
  • Code formatted (uv run ruff check --fix && uv run ruff format)
  • Docs updated (if relevant)
  • CHANGELOG.md entry added

@simonharrer

Copy link
Copy Markdown
Contributor

Happy to include that. Although we already support llms.txt for AI and have an entry in context7.

@simonharrer

Copy link
Copy Markdown
Contributor

Any reason why this is in draft mode?

@pierre-monnet

Copy link
Copy Markdown
Contributor Author

Any reason why this is in draft mode?

@simonharrer
I left the pull request as a draft because I hadn't had time to test it locally yet. It looks good to go now!
image

@pierre-monnet
pierre-monnet marked this pull request as ready for review August 1, 2026 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants