index.md

title	Snakemake Plugin
layout	docs
permalink	/
sidebar	plugin

Snakemake Plugin Documentation Example

{:.no_toc}

This is an example set of documentation for a Snakemake Executor Plugin! You can use this as a starting point for your own plugin. We generally recommend that you include:

• An overview, arguments, and simple usage of your plugin under plugin
• If appropriate (e.g., requiring advanced setup) a tutorial

This template is provided by snakemake/snakemake-plugin-docs-jekyll. if you have any issues, please let us know.

Useful Resources

The following external documentation sites can additionally provide support:

• Snakemake Plugin Docs Jekyll Theme is the underlying theme here.
• Snakemake Executor Plugin Interface defines the interface for creating executor plugins.