Skip to content

Documentation AI Readable - Serve .md files #362

@gkorland

Description

@gkorland
  • Serve markdown versions of your doc pages
    For each documentation page, serve a .md version at the same URL with .md appended. AI tools can parse markdown much better than HTML.

  • Fix your markdown page responses
    Your .md URLs should return valid markdown content, not HTML or error pages. Check that your server properly handles .md file requests.

  • Support Accept: text/markdown content negotiation
    When a request includes an Accept: text/markdown header, your doc pages should return markdown content instead of HTML. This lets AI tools request the format they prefer without needing a separate .md URL.

  • Clean up your markdown output
    Your markdown versions include navigation, footer, or other non-content elements. Strip these to give AI clean, focused content.

Metadata

Metadata

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions