{"id":14979527,"url":"https://github.com/marella/jekyll-theme-documentation","last_synced_at":"2025-10-28T18:31:47.595Z","repository":{"id":44305223,"uuid":"131718816","full_name":"marella/jekyll-theme-documentation","owner":"marella","description":"A Jekyll theme for hosting documentation on GitHub Pages.","archived":false,"fork":false,"pushed_at":"2023-07-08T13:07:59.000Z","size":468,"stargazers_count":17,"open_issues_count":2,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-03T09:16:29.145Z","etag":null,"topics":["github-pages","jekyll","jekyll-theme"],"latest_commit_sha":null,"homepage":"https://marella.github.io/jekyll-theme-documentation/","language":"HTML","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/marella.png","metadata":{"files":{"readme":"README.md","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-01T13:54:07.000Z","updated_at":"2024-03-25T16:41:13.000Z","dependencies_parsed_at":"2024-09-11T14:25:29.599Z","dependency_job_id":"c7af8213-abce-4803-b99c-5ffac62ccf5a","html_url":"https://github.com/marella/jekyll-theme-documentation","commit_stats":{"total_commits":21,"total_committers":2,"mean_commits":10.5,"dds":"0.33333333333333337","last_synced_commit":"76562778eba35284640464d47c4ff51ca4d3880f"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marella%2Fjekyll-theme-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marella%2Fjekyll-theme-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marella%2Fjekyll-theme-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marella%2Fjekyll-theme-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marella","download_url":"https://codeload.github.com/marella/jekyll-theme-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238700460,"owners_count":19515934,"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":["github-pages","jekyll","jekyll-theme"],"created_at":"2024-09-24T14:00:13.510Z","updated_at":"2025-10-28T18:31:47.195Z","avatar_url":"https://github.com/marella.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\npermalink: /\n---\n\n# jekyll-theme-documentation\n\nA Jekyll theme for hosting documentation on GitHub Pages. You can [preview the theme to see what it looks like](https://marella.github.io/jekyll-theme-documentation/), or even [use it today](#usage).\n\n\n## Usage\n\n1. Add the following to your site's `_config.yml`:\n\n    ```yml\n    remote_theme: marella/jekyll-theme-documentation\n    ```\n\n1. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`:\n\n    ```ruby\n    gem \"github-pages\", group: :jekyll_plugins\n    ```\n\n\n## Configuration\n\nThe following variables will be used, if set in your site's `_config.yml`:\n\n```yml\ntitle: [Your project title]\ntoc_min: 2 # Min heading for ToC - h2\ntoc_max: 3 # Max heading for ToC - h3\nhide_toc: [Hide table of contents for all pages]\nnav: [List of navigation links]\nowner_name: [Your name]\nowner_url: [Your website url]\ngoogle_analytics: [Your Google Analytics tracking ID]\n```\n\nIt is recommended to set `permalink: pretty` when `nav` is set. See [`_config.yml`](https://github.com/marella/jekyll-theme-documentation/blob/master/_config.yml).\n\nThe following variables will be used, if set in your page's YAML front matter:\n```yml\nhide_toc: [Hide table of contents for current page]\nhide_nav: [Hide navigation links for current page]\n```\n\nIt is recommended to set `permalink: /` for `README` when `nav` is set.\n\n\n## Development\n\nIf you'd like to preview the theme locally (for example, in the process of proposing a change):\n\n1. Clone the theme's repository (`git clone https://github.com/marella/jekyll-theme-documentation`)\n1. `cd` into the theme's directory\n1. Run `npm install` to install the necessary dependencies\n1. Run `npm start` to start the preview server\n1. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarella%2Fjekyll-theme-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarella%2Fjekyll-theme-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarella%2Fjekyll-theme-documentation/lists"}