Hooking into RDoc for better documentation with automatically executed examples

This page summarizes the projects mentioned and recommended in the original post on /r/ruby

Our great sponsors
  • WorkOS - The modern identity platform for B2B SaaS
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • SaaSHub - Software Alternatives and Reviews
  • hexapdf-website

    The source of the HexaPDF documentation website

  • Since the API documentation was already part of the static website generation, I added an additional hook that scans for specially marked-up verbatim blocks and executes those blocks - see https://github.com/gettalong/hexapdf-website/blob/master/ext/rdoc_pdf_images.rb

  • HexaPDF

    Versatile PDF creation and manipulation for Ruby

  • After I got some feedback about missing examples in the API documentation of HexaPDF, I decided to do something about it.

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo
NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts