{"id":13483917,"url":"https://github.com/jeremyevans/hanna","last_synced_at":"2025-03-27T15:30:42.035Z","repository":{"id":1257583,"uuid":"1196362","full_name":"jeremyevans/hanna","owner":"jeremyevans","description":"RDoc generator designed with simplicity, beauty and ease of browsing in mind","archived":false,"fork":true,"pushed_at":"2023-12-27T20:22:18.000Z","size":381,"stargazers_count":37,"open_issues_count":0,"forks_count":16,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-06-17T05:29:22.942Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"raggi/hanna","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jeremyevans.png","metadata":{"files":{"readme":"README.rdoc","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2010-12-25T00:45:35.000Z","updated_at":"2024-06-17T05:29:22.942Z","dependencies_parsed_at":"2023-08-10T22:58:56.900Z","dependency_job_id":null,"html_url":"https://github.com/jeremyevans/hanna","commit_stats":{"total_commits":231,"total_committers":12,"mean_commits":19.25,"dds":0.6883116883116883,"last_synced_commit":"d335f1da60d0f4e2cac1c1c400cecd807e59377c"},"previous_names":["jeremyevans/hanna","jeremyevans/hanna-nouveau","rdoc/hanna-nouveau"],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyevans%2Fhanna","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyevans%2Fhanna/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyevans%2Fhanna/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyevans%2Fhanna/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeremyevans","download_url":"https://codeload.github.com/jeremyevans/hanna/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245449533,"owners_count":20617187,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T17:01:16.838Z","updated_at":"2025-03-27T15:30:41.640Z","avatar_url":"https://github.com/jeremyevans.png","language":"Ruby","funding_links":[],"categories":["Documentation"],"sub_categories":[],"readme":"= Hanna\n\nHanna is an RDoc generator built with simplicity, beauty\nand ease of browsing in mind.\n\n== Installation\n\n    gem install hanna\n\n== Usage\n\n    rdoc -o doc -f hanna lib\n\nAn alternative is to set the `RDOCOPT` environment variable:\n\n    RDOCOPT=\"-f hanna\"\n\nThis will make RDoc always use hanna unless it is explicitly overridden.\n\n== Integrating with RubyGems\n\nIf you put the following line in your .gemrc, this will make\nRubyGems use Hanna for all rdoc generation:\n\n    rdoc: -f hanna\n\nAfter doing this, if you wish to have documentation for all your installed gems\nto be formatted in hanna:\n\n    gem rdoc --all --overwrite\n\n== Rake task\n\nFor repeated generation of API docs, you can set up a Rake task. Set\nhanna as the RDoc generator:\n\n    require 'rdoc/task'\n    RDoc::Task.new do |rdoc|\n      rdoc.generator = 'hanna'\n    end\n\n== Modification to RDoc\n\nHanna makes a small modification to RDoc to generate more\nfriendly documentation.  It changes label lists to use a table\ninstead of a description list, since it is very difficult to\nget visually appealing styling for description lists without\ncutting corners (like using fixed widths).\n\n== Contributors\n\nThe Hanna template was created by {Mislav}[http://mislav.uniqpath.com/] and\nsince then has seen contributions from:\n\n1. {Tony Strauss}[https://github.com/DesigningPatterns], who participated from\n   the early start and made tons of fixes and enhancements to the template.\n2. {Michael Granger}[https://github.com/ged] who maintained the original RDoc template.\n3. {Hongli Lai}[https://blog.phusion.nl/] with the search filter for methods.\n4. {Erik Hollensbe}[https://github.com/erikh] a serious refactoring and up to\n   date with RDoc 2.5.x and 3.x, now named 'hanna-nouveau'.\n5. {James Tucker}[https://github.com/raggi] minor cleanups and RubyGems integration\n6. {Jeremy Evans}[https://github.com/jeremyevans] RDoc 4+ support, switch from\n   haml/sass to erb, maintenance since 2014.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeremyevans%2Fhanna","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeremyevans%2Fhanna","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeremyevans%2Fhanna/lists"}