After using Gitbook for our API documentation for the past year, I'm looking to migrate to an open source alternative. While Gitbook has a nice UI, we're increasingly frustrated by things like limitations of their free tier and steep pricing jumps. Also their limited customization for API-specific features like request/response examples.

We're maintaining a growing open source project, and quality API documentation is critical for our adoption. I'm looking for solutions that:

- Support OpenAPI/Swagger integration

- Have good Markdown support

- Generate interactive API documentation

- Offer version control (preferably Git-based)

- Can be easily deployed in our CI/CD pipeline

- Support code samples with syntax highlighting

I've looked at Slate, Docusaurus, ReDoc, and Swagger UI, but I'd appreciate any firsthand experiences or recommendations from the community. What are you using for your API docs, and what has your experience been like with setup, maintenance, and community adoption?

Comments (0)

No comments yet

AlphaEvolve: A Gemini-powered coding agent for designing advanced algorithms (deepmind.google)

Show HN: Muscle-Mem, a behavior cache for AI agents (github.com)

José Mujica has died (bbc.co.uk)

What is HDR, anyway? (lux.camera)

Show HN: Semantic Calculator (king-man+woman=?) (calc.datova.ai)

A server that wasn't meant to exist (it-notes.dragas.net)

Git Bug: Distributed, Offline-First Bug Tracker Embedded in Git, with Bridges (github.com)

StackAI (YC W23) Is Hiring Pydantic and FastAPI Wizard (ycombinator.com)

Smalltalk-78 Xerox NoteTaker in-browser emulator (smalltalkzoo.thechm.org)

The cryptography behind passkeys (blog.trailofbits.com)

Our narrative prison (aeon.co)

Hegel 2.0: The imaginary history of ternary computing (2018) (cabinetmagazine.org)

Variadic Switch (pydong.org)

Databricks and Neon (databricks.com)

David Hilbert's radio address (2014) (old.maa.org)

Changes since congestion pricing started in New York (nytimes.com)

We Made CUDA Optimization Suck Less (rightnowai.co)

UK's Ancient Tree Inventory (ati.woodlandtrust.org.uk)

Launch HN: Jazzberry (YC X25) – AI agent for finding bugs

How the economics of multitenancy work (blacksmith.sh)

An accessibility update – GTK Development Blog (blog.gtk.org)

Bus stops here: Shanghai lets riders design their own routes (sixthtone.com)

Perverse incentives of vibe coding (fredbenenson.medium.com)

The recently lost file upload feature in the Nextcloud app for Android (nextcloud.com)

Various Things in MetaPost (2019) (habr.com)

Updated rate limits for unauthenticated requests (github.blog)

Show HN: Lumier – Run macOS VMs in a Docker (github.com)

Interferometer Device Sees Text from a Mile Away (physics.aps.org)

How to Build a Smartwatch: Picking a Chip (ericmigi.com)

The pigeon whistle: A defining sound of old Beijing (2019) (chinatoday.com.cn)

Uber to introduce fixed-route shuttles in major US cities (techcrunch.com)

Finding Beauty and Truth in Mundane Occurrences (quantamagazine.org)

Show HN: CSV GB+ by Data.olllo – Open and Process CSVs Locally (apps.microsoft.com)

Writing that changed how I think about programming languages (bernsteinbear.com)

SMS 2FA is not just insecure, it's also hostile to mountain people (blog.stillgreenmoss.net)

Ash Framework – Model your domain, derive the rest (ash-hq.org)

Show HN: I’ve built an IoT device to let my family know when I’m in a meeting (nullonerror.org)

Flattening Rust’s learning curve (corrode.dev)

The overlooked masterpiece full of coded messages about World War One (bbc.com)

TwoFold (2f), CLI text expander/template engine (github.com)

RPG in a Box (rpginabox.com)

Type-constrained code generation with language models (arxiv.org)

Breaking the Sound Barrier Part I: Fuzzing CoreAudio with Mach Messages (googleprojectzero.blogspot.com)

Branch Privilege Injection: Exploiting branch predictor race conditions (comsec.ethz.ch)

E-COM: The $40M USPS project to send email on paper (buttondown.com)

Launch HN: Miyagi (YC W25) turns YouTube videos into online, interactive courses

U.S. nuclear base hidden under Greenland's ice for decades (wsj.com)

Show HN: HelixDB – Open-source vector-graph database for AI applications (Rust) (github.com)

Infrastructure, Common Goods, and the Future of Open Source Software (v5.chriskrycho.com)

Replicube: A puzzle game about writing code to create shapes (store.steampowered.com)

Ask HN: Gitbook Alternatives for API Documentation?

Comments (0)