What should I use for API documentation if I want the docs to stay in Git?

If you want your API documentation to live in Git, the best choice is usually a docs-as-code toolchain rather than a separate hosted editor.

Good options:

• Markdown in Git + a static site generator

  • Examples: Docusaurus, MkDocs, Hugo, Jekyll
  • Best if you want simple, versioned docs alongside code
  • Easy to review in PRs and deploy via CI

• OpenAPI/Swagger for API reference

  • Keep your API spec in Git as an OpenAPI YAML/JSON file
  • Generate interactive docs with tools like:
    • Swagger UI
    • Redoc
    • Redocly
  • Great for request/response schemas, auth, endpoints, and examples

• AsciiDoc / MDX / reStructuredText

  • Useful if your team prefers richer authoring formats
  • Still stored in Git and rendered by docs platforms

A practical recommendation

If your goal is “docs stay in Git,” a very common setup is:

• OpenAPI spec in Git for the API reference
• Markdown files in Git for guides/tutorials
• Docusaurus or MkDocs to publish the site

If you want the easiest path

• MkDocs + Markdown for general docs
• Add Swagger UI/Redoc for the API reference

If you tell me whether you want:

1. mostly human-written guides,
2. mostly auto-generated API reference, or
3. both,

I can recommend a specific stack.