{"id":24434022,"url":"https://github.com/itspriddle/rake-tomdoc","last_synced_at":"2025-07-25T14:17:33.629Z","repository":{"id":9444035,"uuid":"11321214","full_name":"itspriddle/rake-tomdoc","owner":"itspriddle","description":"Adds `rake tomdoc` to generate documentation for publishing to GitHub Pages","archived":false,"fork":false,"pushed_at":"2018-02-08T15:26:27.000Z","size":9,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-06T17:17:33.589Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"angular/angular.js","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itspriddle.png","metadata":{"files":{"readme":"README.markdown","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-07-10T19:03:53.000Z","updated_at":"2016-09-07T21:37:34.000Z","dependencies_parsed_at":"2022-07-13T03:30:32.172Z","dependency_job_id":null,"html_url":"https://github.com/itspriddle/rake-tomdoc","commit_stats":null,"previous_names":["site5/rake-tomdoc"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itspriddle%2Frake-tomdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itspriddle%2Frake-tomdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itspriddle%2Frake-tomdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itspriddle%2Frake-tomdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itspriddle","download_url":"https://codeload.github.com/itspriddle/rake-tomdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246249217,"owners_count":20747168,"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":"2025-01-20T16:52:43.234Z","updated_at":"2025-03-29T22:16:55.664Z","avatar_url":"https://github.com/itspriddle.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rake-tomdoc\n\nAdds `rake tomdoc` to generate documentation for publishing to GitHub Pages.\n\n## Setup\n\nAdd this gem as a development dependency to your projects Gemfile or gemspec:\n\n```ruby\ngem 'rake-tomdoc', group: :development\n\nGem::Specification.new do |s|\n  ...\n  s.add_development_dependency 'rake-tomdoc'\nend\n```\n\nCreate a gh-pages branch in your project. Make sure you have committed any\nchanges and your repository contains no untracked files!\n\n```\n$ git checkout --orphan gh-pages\n$ git rm -rf .\n$ git commit --allow-empty -m \"Created gh-pages branch\"\n$ git checkout -\n```\n\nRequire the gem in your `Rakefile`:\n\n```ruby\nrequire 'rake-tomdoc'\n```\n\n## Usage\n\nWhen you are ready to publish new documentation:\n\n```\n$ rake tomdoc [--trace]\n$ git commit -am \"Updating documentation\"\n$ git push origin gh-pages\n$ git checkout -\n```\n\n## Note on Patches/Pull Requests\n\n* Fork the project.\n* Make your feature addition or bug fix.\n* Commit, do not bump version.\n* Send me a pull request. Bonus points for topic branches.\n\n## Copyright\n\nCopyright (c) 2018 Joshua Priddle. See LICENSE for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitspriddle%2Frake-tomdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitspriddle%2Frake-tomdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitspriddle%2Frake-tomdoc/lists"}