{"id":19227945,"url":"https://github.com/snakemake/snakemake-plugin-docs-jekyll","last_synced_at":"2026-05-31T16:31:53.187Z","repository":{"id":188370086,"uuid":"678615235","full_name":"snakemake/snakemake-plugin-docs-jekyll","owner":"snakemake","description":"Jekyll template for snakemake plugins (under development)!","archived":false,"fork":false,"pushed_at":"2023-08-15T01:48:56.000Z","size":1790,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-23T10:29:30.547Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/snakemake.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}},"created_at":"2023-08-15T01:02:14.000Z","updated_at":"2023-08-15T01:04:02.000Z","dependencies_parsed_at":"2023-08-15T03:39:29.862Z","dependency_job_id":"9e5ee09f-f24b-425c-a4c7-06a02da047f6","html_url":"https://github.com/snakemake/snakemake-plugin-docs-jekyll","commit_stats":null,"previous_names":["snakemake/snakemake-plugin-docs-jekyll"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/snakemake/snakemake-plugin-docs-jekyll","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snakemake%2Fsnakemake-plugin-docs-jekyll","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snakemake%2Fsnakemake-plugin-docs-jekyll/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snakemake%2Fsnakemake-plugin-docs-jekyll/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snakemake%2Fsnakemake-plugin-docs-jekyll/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snakemake","download_url":"https://codeload.github.com/snakemake/snakemake-plugin-docs-jekyll/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snakemake%2Fsnakemake-plugin-docs-jekyll/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33739861,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-31T02:00:06.040Z","response_time":95,"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":[],"created_at":"2024-11-09T15:25:59.667Z","updated_at":"2026-05-31T16:31:53.169Z","avatar_url":"https://github.com/snakemake.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Snakemake Plugin Jekyll Docs Template\n\n![assets/img/snakemake-logo.png](assets/img/snakemake-logo.png)\n\nThis is a Snakemake jekyll template intended for plugin authors to easily deploy\ndocumentation alongside their repositories. Snakemake currently supports the following\nplugin types:\n\n - [Executor Plugins](https://github.com/snakemake/snakemake-interface-executor-plugins)\n\n## Usage\n\nUsing the [theme](https://rubygems.org/gems/snakemake-plugin-jekyll) is easy - \njust add it as a `remote_theme` to your config yaml. \nWe will be providing an example site (to use as a template) soon!\n\n```bash\n# Theme for docs\nplugins:\n  - jekyll-remote-theme\n\nremote_theme: snakemake/snakemake-plugin-docs-jekyll\n```\n\nAnd add \n\n```\ngem \"jekyll-remote-theme\"\n```\n\nto your Gemfile.\n\n### Add a Page\n\nAnd then you can add any pages with the following front end matter (header)\nto use the documentation template.\n\n```\n---\ntitle: plugin\nlayout: docs\npermalink: /cmake/\n---\n```\n\n### Add a Sidebar\n\nTo add a sidebar to your pages, create a file under `_data/menus/` that is named\naccording to your sidebar, e.g., `_data/menus/mysidebar.yaml` for a sidebar named `mysidebar`.\nThe file should be a flat list of names and urls:\n\n```yaml\n- title: My Page\n  url: \"mypage\"\n- title: Root of Site\n  url: \"\"\n```\n\nAnd then you can add this to the front end matter of pages where you want it to appear:\n\n```\n---\ntitle: plugin\nlayout: docs\nsidebar: mysidebar\npermalink: /pagename/\n---\n```\n\n## Development\n\nIf you want to use the gem, it is built during CI, and release is currently done from the command line:\n\n```bash\n$ /bin/bash script/release.sh\n```\n\nBut this isn't required since we can use `jekyll-remote-theme` and use it directly from GitHub.\nIf you do release, you should bump the version in [snakemake-plugin-docs-jekyll.gemspec](snakemake-plugin-docs-jekyll.gemspec)\nand be on the main branch.\n\n\n## License\n\nHPCIC DevTools is distributed under the terms of the MIT license.\nAll new contributions must be made under this license.\n\nSee [LICENSE](https://github.com/converged-computing/cloud-select/blob/main/LICENSE),\n[COPYRIGHT](https://github.com/converged-computing/cloud-select/blob/main/COPYRIGHT), and\n[NOTICE](https://github.com/converged-computing/cloud-select/blob/main/NOTICE) for details.\n\nSPDX-License-Identifier: (MIT)\n\nLLNL-CODE- 842614","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnakemake%2Fsnakemake-plugin-docs-jekyll","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnakemake%2Fsnakemake-plugin-docs-jekyll","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnakemake%2Fsnakemake-plugin-docs-jekyll/lists"}