{"id":22229708,"url":"https://github.com/boycce/github-docs","last_synced_at":"2026-03-19T22:09:09.835Z","repository":{"id":56874321,"uuid":"264338712","full_name":"boycce/github-docs","owner":"boycce","description":"A Jekyll theme for Github styled documentation","archived":false,"fork":false,"pushed_at":"2022-04-16T04:06:04.000Z","size":123,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-20T16:48:46.653Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://boycce.github.io/github-docs/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boycce.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-16T01:58:27.000Z","updated_at":"2022-02-25T23:51:59.000Z","dependencies_parsed_at":"2022-08-20T22:30:36.780Z","dependency_job_id":null,"html_url":"https://github.com/boycce/github-docs","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boycce%2Fgithub-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boycce%2Fgithub-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boycce%2Fgithub-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boycce%2Fgithub-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boycce","download_url":"https://codeload.github.com/boycce/github-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245431709,"owners_count":20614182,"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-12-03T01:12:03.020Z","updated_at":"2026-01-05T21:46:22.609Z","avatar_url":"https://github.com/boycce.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Github docs\n\nA Jekyll theme for Github styled documentation\n\n### Theme usage\n\n1. To use this theme in your project via `github-pages`, add a _config.yml file with this line\n    ```yaml\n    remote_theme: boycce/github-docs\n    ```\n\n### Theme usage (local preview)\n\n1. To preview this theme for your project, add the following Gemfile in your root folder\n    ```ruby\n    source 'https://rubygems.org'\n\n    # Use one of the following:\n\n    # 1. simulate github-pages\n    gem 'github-pages', group: :jekyll_plugins\n\n    # 2. Or use jekyll-remote-theme, contains unsupported dependency versions, e.g. Sass issues\n    #   https://github.com/MichaelCurrin/jekyll-theme-quickstart/tree/gh-pages\n    # gem \"github-docs\", git: \"https://github.com/boycce/github-docs\"\n    # group :jekyll_plugins do\n    #   gem \"jekyll-remote-theme\", \"~\u003e 0.4.2\"\n    # end\n    ```\n\n2. Install or update dependencies\n    ```\n    $ bundle install // or bundle update\n    ```\n\n3. And run (github-pages pulls the latest remote_theme)\n    ```\n    $ bundle exec jekyll serve\n    ```\n\n### Development\n\n1. Install rvm/ruby `^2.7.3` if not having done so already\n2. (a) `$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag ` (not sudo, or....)\n3. (b) `$ bundle install` (install theme deps automatically)\n4. `$ jekyll serve --port 4001`\n\n### Publishing Gem\n\n1. `$ gem build github-docs.gemspec`\n2. `$ gem push github-docs-*.gem`\nor\n1. `$ rm ./*.gem 2\u003e/dev/null \u0026\u0026 gem build github-docs.gemspec \u0026\u0026 gem push github-docs-*.gem`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboycce%2Fgithub-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboycce%2Fgithub-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboycce%2Fgithub-docs/lists"}