Search results

Publishing your API documentation

Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 4,500+ subscribers

API documentation often follows a docs-as-code workflow, where the tools to author and publish documentation align closely with the same tools developer use to write code. This involves using lightweight formats such as Markdown, collaborating with Git or other version control, building your doc site with a static site generator, and deploying it through a continuous build model, where the build happens on the server when you push commits to a particular branch.

73% Complete

73/110 pages complete. Only 37 more pages to go...

Donate?

Want to buy me lunch? Click the Donate button below to donate $10 through Paypal.