{"id":47721220,"url":"https://github.com/trhodeos/yard-ghpages","last_synced_at":"2026-04-02T19:35:58.472Z","repository":{"id":7942429,"uuid":"9335027","full_name":"trhodeos/yard-ghpages","owner":"trhodeos","description":"Easily push yard docs to Github Pages","archived":false,"fork":false,"pushed_at":"2021-03-14T21:47:35.000Z","size":83,"stargazers_count":13,"open_issues_count":1,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-01-14T00:20:08.175Z","etag":null,"topics":["gh-pages","github-page","rake","yard","yard-docs"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/trhodeos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-10T01:02:40.000Z","updated_at":"2023-10-06T23:03:51.000Z","dependencies_parsed_at":"2022-08-21T01:50:26.082Z","dependency_job_id":null,"html_url":"https://github.com/trhodeos/yard-ghpages","commit_stats":null,"previous_names":["tylerrhodes/yard-ghpages"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/trhodeos/yard-ghpages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trhodeos%2Fyard-ghpages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trhodeos%2Fyard-ghpages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trhodeos%2Fyard-ghpages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trhodeos%2Fyard-ghpages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trhodeos","download_url":"https://codeload.github.com/trhodeos/yard-ghpages/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trhodeos%2Fyard-ghpages/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31314380,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["gh-pages","github-page","rake","yard","yard-docs"],"created_at":"2026-04-02T19:35:57.790Z","updated_at":"2026-04-02T19:35:58.456Z","avatar_url":"https://github.com/trhodeos.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yard::GHPages\n\nA simple set of Rake tasks that generates Yard docs and publishes them to github\npages.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n    gem 'yard-ghpages'\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install yard-ghpages\n\n## Usage\n\nThis gem exposes two new rake tasks: `yard:build` and `yard:publish`.\n\nTo use this gem, install in the `Rakefile`.\n```\nrequire 'yard-ghpages'\nYard::GHPages::Tasks.install_tasks\n```\n\nBuild the yard docs.\n```\nrake yard:build\n```\n\nCommit the changes.\n```\ngit commit -am 'Update yard docs'\n```\n\nPublish the docs to github pages.\n```\nrake yard:publish\n```\n\nEasy as that!\n\n## Optional Configuration\n\nInclude a file called .yard-gh-pages.yml in the root of your project.\n\nOptions:\n- source_branch (default: 'master')\n  - Branch that should be used to pull the latest directory of generated YARD files\n- source_directory (default: 'docs')\n  - Directory within the source_branch that contains the generated YARD files\n- destination_branch (default: 'gh-pages')\n  - Branch within github where the YARD files should be pushed. 'gh-pages' is also the default branch used by Github.\n\nExample file:\n```yaml\nsource_branch: 'master'\nsource_directory: 'docs'\ndestination_branch: 'gh-pages'\n```\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrhodeos%2Fyard-ghpages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrhodeos%2Fyard-ghpages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrhodeos%2Fyard-ghpages/lists"}