{"id":15651243,"url":"https://github.com/carlosperate/jekyll-theme-rtd","last_synced_at":"2026-03-14T00:53:46.634Z","repository":{"id":53490664,"uuid":"216384001","full_name":"carlosperate/jekyll-theme-rtd","owner":"carlosperate","description":"Port of the Read the Docs theme to Jekyll to use with GitHub Pages.","archived":false,"fork":false,"pushed_at":"2026-02-24T22:27:45.000Z","size":6564,"stargazers_count":59,"open_issues_count":12,"forks_count":85,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-02-24T22:58:12.811Z","etag":null,"topics":["gh-pages","github-pages","github-pages-template","github-pages-theme","jekyll-template","jekyll-theme","readthedocs","rtd"],"latest_commit_sha":null,"homepage":"https://carlosperate.github.io/jekyll-theme-rtd","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/carlosperate.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-10-20T15:30:49.000Z","updated_at":"2026-02-24T22:27:49.000Z","dependencies_parsed_at":"2024-10-03T12:38:38.389Z","dependency_job_id":"530a9cdd-9719-4a2b-bcc3-fd0669fbe79c","html_url":"https://github.com/carlosperate/jekyll-theme-rtd","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/carlosperate/jekyll-theme-rtd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carlosperate%2Fjekyll-theme-rtd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carlosperate%2Fjekyll-theme-rtd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carlosperate%2Fjekyll-theme-rtd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carlosperate%2Fjekyll-theme-rtd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/carlosperate","download_url":"https://codeload.github.com/carlosperate/jekyll-theme-rtd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carlosperate%2Fjekyll-theme-rtd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29808931,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-24T22:43:48.403Z","status":"online","status_checked_at":"2026-02-25T02:00:07.329Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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-pages","github-pages-template","github-pages-theme","jekyll-template","jekyll-theme","readthedocs","rtd"],"created_at":"2024-10-03T12:37:36.982Z","updated_at":"2026-03-14T00:53:46.624Z","avatar_url":"https://github.com/carlosperate.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Read The Docs Theme for Jekyll and GitHub Pages\n\nPort of the Read the Docs theme to Jekyll that can be used with GitHub Pages.\n\n\nThe [theme documentation](https://carlosperate.github.io/jekyll-theme-rtd) is\nalso the live demo:\n\n[![theme screenshot](docs/assets/img/screenshot.png)](https://carlosperate.github.io/jekyll-theme-rtd)\n\nThe original [Read The Docs](https://sphinx-rtd-theme.readthedocs.io)\ntheme was created for [Sphinx](https://www.sphinx-doc.org/), and so it is\ndesigned specifically for documentation.\nCombined with [GitHub Pages](https://pages.github.com) it's a great and easy\nway to document your projects.\n\nCheck out the [🚀 quick start guide](https://carlosperate.github.io/jekyll-theme-rtd/quickstart.html)\nto see how easy it is to get started!\n\nFeatures:\n\n- ✅ Responsive design with a collapsible sidebar navigation\n- ✅ \"Edit on GitHub\" link for each page\n- ✅ Built-in search functionality using [Lunr.js](https://lunrjs.com/)\n- ✅ Source code highlighting using the [highlight.js](https://highlightjs.org)\n- ✅ Specifically developed to be compatible with GitHub Pages\n- ✅ SEO-friendly meta tags and canonical URLs\n- ✅ Configurable with custom options in `_config.yml` and front matter\n- 🧑‍💻 TODO: Social media preview images\n- 🧑‍💻 TODO: Admonition notes\n\n### 🚧 Work in Progress!\n\nThis theme is currently being developed but v1.0 is already usable and released.\nSome features are still missing and breaking changes (mostly config names and\ndefault values) will be released as major uprevs.\n\nSo it is recommended to lock the version of the theme to a specific version\nin the `_config.yml` file: `remote_theme: carlosperate/jekyll-theme-rtd@v1.1.0`\n\nMissing features are listed in the GitHub issues with the\n[enhancement](https://github.com/carlosperate/jekyll-theme-rtd/issues?q=is%3Aissue%20state%3Aopen%20label%3Aenhancement)\nor [new feature](https://github.com/carlosperate/jekyll-theme-rtd/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22new%20feature%22)\nlabels, and any known issues are listed with the\n[bug](https://github.com/carlosperate/jekyll-theme-rtd/issues?q=is%3Aissue+is%3Aopen+label%3Abug)\nlabel.\n\nContributions are very welcomed!\n\n## 👨‍👩‍👧‍👦 Contributing\n\nBug reports and pull requests are welcome on GitHub at\nhttps://github.com/carlosperate/jekyll-theme-rtd.\n\nFor information about contributing, see the\n[developer documentation](https://carlosperate.github.io/jekyll-theme-rtd/dev.html).\n\nThis project is intended to be a safe, welcoming space for collaboration, and\ncontributors are expected to adhere to the\n[Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## ⚖️ License\n\nThis theme is based on the [MkDocs](https://github.com/mkdocs/mkdocs)\n[`readthedocs` port](https://github.com/mkdocs/mkdocs/tree/1.0.4/mkdocs/themes/readthedocs).\nCopyright © 2014, Tom Christie, all rights reserved, and released under the\n[BSD 2-Clause \"Simplified\" License](LICENSE).\n\nThe theme modifications to port it to Jekyll can be seen\n[in this diff](https://github.com/carlosperate/jekyll-theme-rtd/compare/dddce9f13fde24c03aee4533158c43091120d47e...main),\nand this project is also released under the\n[BSD 2-Clause \"Simplified\" License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarlosperate%2Fjekyll-theme-rtd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcarlosperate%2Fjekyll-theme-rtd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarlosperate%2Fjekyll-theme-rtd/lists"}