{"id":16068033,"url":"https://github.com/ged/darkfish","last_synced_at":"2026-03-08T19:36:48.936Z","repository":{"id":65987990,"uuid":"2623293","full_name":"ged/darkfish","owner":"ged","description":"A project to make a complete replacement for the default HTML generator for Rdoc, the API documentation-extraction system for Ruby. (github mirror)","archived":false,"fork":false,"pushed_at":"2017-06-29T17:19:39.000Z","size":544,"stargazers_count":36,"open_issues_count":1,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-28T01:49:08.596Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://deveiate.org/projects/Darkfish-RDoc","language":"Ruby","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ged.png","metadata":{"files":{"readme":"README","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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2011-10-21T21:39:52.000Z","updated_at":"2025-02-25T08:50:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"26a20b02-7821-4823-a589-a15f84946915","html_url":"https://github.com/ged/darkfish","commit_stats":{"total_commits":43,"total_committers":3,"mean_commits":"14.333333333333334","dds":"0.046511627906976716","last_synced_commit":"b3a5d7390bf95c87d952a29d6c9644b60f7dc579"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ged%2Fdarkfish","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ged%2Fdarkfish/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ged%2Fdarkfish/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ged%2Fdarkfish/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ged","download_url":"https://codeload.github.com/ged/darkfish/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243871888,"owners_count":20361379,"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-10-09T06:08:04.077Z","updated_at":"2025-10-30T21:06:25.829Z","avatar_url":"https://github.com/ged.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"= Darkfish Rdoc Generator\n\nThis is a complete replacement for the default HTML generator for Rdoc 2. \n\nI created it with a few goals in mind:\n\n* Replace the four-frame layout with three different indexes with a single-page, \n  class/module-focused view.\n\n* I helped write what became the default look and feel for Rdoc, but it's \n  starting to show its age. I wanted to update it with new CSS and Javascript \n  for modern browsers.\n\n* Add some of the nifty searching and index-on-the-side stuff I liked from the\n  modified Allison template (http://www.superalloy.nl/blog/?p=7) Eloy \n  Duran came up with.\n\n* Implemented using separate ERB template files instead of Rdoc's \n  constants-in-a-module style templating.\n\nI think I mostly succeeded, and it's nice enough that I wanted to use it for all\nmy documentation, and I thought you might want to, too. Or at least be able to\ntweak it to generate your own spiffy docs.\n\nIt looks like this:\n\nhttp://deveiate.org/darkfish_preview.png\n\n== Getting Started\n\nIf you haven't installed it yet, you can install it via RubyGems:\n\n $ sudo gem install darkfish-rdoc\n\nOr download the source and do:\n\t\n $ sudo rake install\n\n== Usage\n\nIf you're using RDoc 2.3 or later, the Darkfish formatter will be automatically discovered when RDoc\nis loaded, so you only have to specify that you want the 'darkfish' formatter:\n\n $ rdoc -w 4 -SHN -f darkfish -m README README lib\n\nIt's equally easy to specify from a Rakefile in an RDocTask:\n\n  ### Task: rdoc\n  require 'rake/rdoctask'\n  gem 'darkfish-rdoc' # Omit this if it's installed as a regular library\n\n  Rake::RDocTask.new do |rdoc|\n    rdoc.title    = \"My Awesome SnoCone Library\"\n  \n    rdoc.options += [\n        '-w', '4',\n        '-SHN',\n        '-f', 'darkfish', # This bit\n        '-m', 'README',\n      ]\n    \n    rdoc.rdoc_files.include 'README'\n    rdoc.rdoc_files.include 'lib/snocone.rb'\n  end\n  \n  \nThat's it.\n\n== Feedback\n\nI'd be happy to have feedback via email (ged at FaerieMUD dot org)\nor a ticket on the project's Trac:\n\n  http://deveiate.org/projects/Darkfish-RDoc/\n\n== License\n\nSee the LICENSE file included with the distribution for copyright and licensing details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fged%2Fdarkfish","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fged%2Fdarkfish","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fged%2Fdarkfish/lists"}