3 lines
13 KiB
HTML
3 lines
13 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Plugins · PkgTemplates.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link href="../../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>PkgTemplates.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../../search/"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../../">Home</a></li><li><a class="toctext" href="../package_generation/">Package Generation</a></li><li class="current"><a class="toctext" href>Plugins</a><ul class="internal"><li><a class="toctext" href="#Continuous-Integration-(CI)-1">Continuous Integration (CI)</a></li><li><a class="toctext" href="#Code-Coverage-1">Code Coverage</a></li><li><a class="toctext" href="#Documentation-1">Documentation</a></li></ul></li><li><a class="toctext" href="../plugin_development/">Plugin Development</a></li><li><a class="toctext" href="../licenses/">Licenses</a></li><li><a class="toctext" href="../">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href>Plugins</a></li></ul><a class="edit-page" href="https://github.com/invenia/PkgTemplates.jl/blob/master/docs/src/pages/plugins.md#L"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Plugins</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Plugins-1" href="#Plugins-1">Plugins</a></h1><p>Plugins are the secret sauce behind <code>PkgTemplates</code>'s customization and extension. This page describes plugins that already exist; for information on writing your own plugins, see <a href="../plugin_development/#Plugin-Development-1">Plugin Development</a>.</p><h2><a class="nav-anchor" id="Continuous-Integration-(CI)-1" href="#Continuous-Integration-(CI)-1">Continuous Integration (CI)</a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.TravisCI" href="#PkgTemplates.TravisCI"><code>PkgTemplates.TravisCI</code></a> — <span class="docstring-category">Type</span>.</div><div><div><pre><code class="language-none">TravisCI(; config_file::Union{AbstractString, Nothing}="") -> TravisCI</code></pre><p>Add <code>TravisCI</code> to a template's plugins to add a <code>.travis.yml</code> configuration file to generated repositories, and an appropriate badge to the README.</p><p><strong>Keyword Arguments:</strong></p><ul><li><code>config_file::Union{AbstractString, Nothing}=""</code>: Path to a custom <code>.travis.yml</code>. If <code>nothing</code> is supplied, no file will be generated.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/77387b267b107cc3b2ee72ffc9c0420f95283fc8/src/plugins/travisci.jl#LL1-L10">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.AppVeyor" href="#PkgTemplates.AppVeyor"><code>PkgTemplates.AppVeyor</code></a> — <span class="docstring-category">Type</span>.</div><div><div><pre><code class="language-none">AppVeyor(; config_file::Union{AbstractString, Nothing}="") -> App
|