{"id":18810408,"url":"https://github.com/absaoss/gh-pages-skeleton","last_synced_at":"2025-04-13T20:31:03.316Z","repository":{"id":36668160,"uuid":"229107671","full_name":"AbsaOSS/gh-pages-skeleton","owner":"AbsaOSS","description":"Serve as a starter of github pages for any project of AbsaOSS","archived":false,"fork":false,"pushed_at":"2023-03-09T05:49:13.000Z","size":100,"stargazers_count":5,"open_issues_count":12,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-12T07:05:51.813Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AbsaOSS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2019-12-19T17:38:29.000Z","updated_at":"2022-05-03T06:11:32.000Z","dependencies_parsed_at":"2023-01-17T03:54:37.756Z","dependency_job_id":null,"html_url":"https://github.com/AbsaOSS/gh-pages-skeleton","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fgh-pages-skeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fgh-pages-skeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fgh-pages-skeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fgh-pages-skeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AbsaOSS","download_url":"https://codeload.github.com/AbsaOSS/gh-pages-skeleton/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223603282,"owners_count":17172075,"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-11-07T23:20:06.229Z","updated_at":"2024-11-07T23:20:06.936Z","avatar_url":"https://github.com/AbsaOSS.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Github Pages Starter\n\nThis repositories purpose is to serve as a starter of github pages for any project of AbsaOSS\n\n### Dependencies:\n- ruby \u003e= 2.3.0\n\n### To build locally:\n```bash\n# In the root of the project\n$\u003e git checkout gh-pages\n$\u003e bundle install\n$\u003e bundle exec jekyll serve\n# =\u003e Now browse to http://localhost:4000\n```\n\n### Run convinience scripts\n#### Init new docs\n- Name - Name of the project\n- Description - Description of the project\n- Version - on which version should docs start\n\n```ruby\nruby utils/init_docs.rb \u003cname\u003e \u003cdescription\u003e \u003coptional_version\u003e\n```\n\n#### Add/Remove topic\nAutomatically add or remove topic with adding it to menu as well\n\n- Action - add or remove\n- Topic Name - topic name in the \"file form\" so Build Process would be build-process\n\n```ruby\nruby utils/manage_topics.rb \u003caction\u003e \u003ctopic_name\u003e\n```\n\n#### Generate new docs versiom\nGenerates new docs version folder with the specified version\n\n```ruby\nruby utils/create_docs.rb \u003cversion\u003e\n```\n\n#### Generate release notes\nA Ruby script to generate release notes.\n\n```bash\nUsage: ruby utils/get_release_notes.rb VERSION [options]\n\nSpecific options:\n        --github-token TOKEN         Github token. Can be specified using environment variable GITHUB_TOKEN or in get_release_notes.json in resources using github_token key\n        --zenhub-token TOKEN         Zenhub token. This means we will use Release object for release notes. You don't have to use --use-zenhub in case you do this. Can be specified using environment variable ZENHUB_TOKEN or in get_release_notes.json in resources using zenhub_token key\n    -z, --use-zenhub                 Run using zenhub. It needs zenhub token set. If you use --zenhub-token option, you don't need to use this. This means we will use Release object for release notes.\n        --organization ORGANIZATION  Github Organization\n        --repository REPOSITORY      Github Repository name\n        --repository-id REPOSITORYID Zenhub Repository ID\n        --zenhub-url ZENURL          Zenhub API URL\n        --github-url GITURL          Github API URL\n    -p, --[no-]print-empty           Should Issue with no release notes comment be included in the output file\n        --[no-]print-only-title      Should Issue with no release notes comment be preceeded with 'Couldn't find comment'\n    -s, --[no-]strict                Treats warnings as errors\n    -h, --help                       Show this message\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabsaoss%2Fgh-pages-skeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabsaoss%2Fgh-pages-skeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabsaoss%2Fgh-pages-skeleton/lists"}