Skip to content

Documentation AI Readable - Serve .md files #362

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.

Activity

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions