https://github.com/snakemake/snakemake-plugin-docs-example
An example documentation site for a plugin using snakemake-plugin-docs-jekyll
https://github.com/snakemake/snakemake-plugin-docs-example
snakemake snakemake-plugin snakemake-theme
Last synced: over 1 year ago
JSON representation
An example documentation site for a plugin using snakemake-plugin-docs-jekyll
- Host: GitHub
- URL: https://github.com/snakemake/snakemake-plugin-docs-example
- Owner: snakemake
- Created: 2023-08-15T01:49:59.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-15T01:50:45.000Z (almost 3 years ago)
- Last Synced: 2025-01-04T22:26:12.329Z (over 1 year ago)
- Topics: snakemake, snakemake-plugin, snakemake-theme
- Language: Ruby
- Homepage: https://snakemake.github.io/snakemake-plugin-docs-example/
- Size: 5.86 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Snakemake Docs Example
This is an example project that uses the [snakemake-plugin-docs-jekyll](https://github.com/snakemake/snakemake-plugin-docs-jekyll) theme
and customizes it for Snakemake plugins. Complete instructions for the theme are provided in the README [there](https://github.com/snakemake/snakemake-plugin-docs-jekyll).
The recommended approach to use this theme is to:
1. Clone or use it as a template
2. Move the entire root into a "docs" subdirectory
3. Turn on GitHub pages for this documentation directory
The above will serve documentation for your plugin directly from GitHub! If we update
the plugin templating, unless you pin a particular version, you will see updates for your
repository on fresh builds.
## Extra Notes
- Feel free to add other code or config files in the tutorial directory.
- Any Jekyll path in the template can be over-ridden if you provide the same path locally.