Packages

Elixir template generator

Current section

Files

Jump to
template_generator doc api-reference.html
Raw

doc/api-reference.html

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.28.3">
<meta name="project" content="template_generator v0.1.0">
<title>API Reference — template_generator v0.1.0</title>
<link rel="stylesheet" href="dist/elixir-d5ff82e6b0f5651c0ac0.css" />
<script src="dist/sidebar_items-6bfb3178f9.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/app-a088a6cc33ae3464193e.js"></script>
</head>
<body data-type="extras">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<section class="sidebar">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="template_generator.html" class="sidebar-projectName" translate="no">
template_generator
</a>
<strong class="sidebar-projectVersion" translate="no">
v0.1.0
</strong>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
<li><a id="tasks-list-link" href="#full-list"><span translate="no">Mix</span> Tasks</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<span>API Reference <small class="app-vsn">template_generator v0.1.0</small></span>
</h1>
<section class="details-list">
<h2 id="modules" class="section-heading">
<a href="#modules" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">modules</p>
</a>
Modules
</h2>
<div class="summary">
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.html" translate="no">Generator</a>
</div>
<div class="summary-synopsis"><p>Generator task entrypoint</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Path.Adapters.GitResolver.html" translate="no">Generator.Path.Adapters.GitResolver</a>
</div>
<div class="summary-synopsis"><p>Resolves paths for git template option</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Path.Adapters.JsonResolver.html" translate="no">Generator.Path.Adapters.JsonResolver</a>
</div>
<div class="summary-synopsis"><p>Resolves paths for json template option</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Path.Adapters.LocalResolver.html" translate="no">Generator.Path.Adapters.LocalResolver</a>
</div>
<div class="summary-synopsis"><p>Resolves paths for local template option</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Path.Adapters.PathCreator.html" translate="no">Generator.Path.Adapters.PathCreator</a>
</div>
<div class="summary-synopsis"><p>Project template path creator</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Path.Adapters.TemplateDirectory.html" translate="no">Generator.Path.Adapters.TemplateDirectory</a>
</div>
<div class="summary-synopsis"><p>Project template directory resolutions</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Path.Adapters.TemplateFile.html" translate="no">Generator.Path.Adapters.TemplateFile</a>
</div>
<div class="summary-synopsis"><p>Project template file resolutions</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Path.Schemas.TemplateDirectory.html" translate="no">Generator.Path.Schemas.TemplateDirectory</a>
</div>
<div class="summary-synopsis"><p>Schema representing a template directory</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Path.Schemas.TemplateFile.html" translate="no">Generator.Path.Schemas.TemplateFile</a>
</div>
<div class="summary-synopsis"><p>Schema representing a template file</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Paths.html" translate="no">Generator.Paths</a>
</div>
<div class="summary-synopsis"><p>Template generator paths context external API</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Project.Adapters.Project.html" translate="no">Generator.Project.Adapters.Project</a>
</div>
<div class="summary-synopsis"><p>Project resolutions</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Project.Schemas.Project.html" translate="no">Generator.Project.Schemas.Project</a>
</div>
<div class="summary-synopsis"><p>Schema representing a project</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Projects.html" translate="no">Generator.Projects</a>
</div>
<div class="summary-synopsis"><p>Template generator projects context external API</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Template.Adapters.Template.html" translate="no">Generator.Template.Adapters.Template</a>
</div>
<div class="summary-synopsis"><p>Template resolutions</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Template.Schemas.Template.html" translate="no">Generator.Template.Schemas.Template</a>
</div>
<div class="summary-synopsis"><p>Schema representing a Template</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Generator.Templates.html" translate="no">Generator.Templates</a>
</div>
<div class="summary-synopsis"><p>Template generator templates context external API</p></div>
</div>
</div>
</section>
<section class="details-list">
<h2 id="mix-tasks" class="section-heading">
<a href="#mix-tasks" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">mix-tasks</p>
</a>
Mix Tasks
</h2>
<div class="summary">
<div class="summary-row">
<div class="summary-signature">
<a href="Mix.Tasks.Generator.New.html" translate="no">mix generator.new</a>
</div>
<div class="summary-synopsis"><p>Generate new module using template</p></div>
</div>
</div>
</section>
<div class="bottom-actions">
<div class="bottom-actions-item">
</div>
<div class="bottom-actions-item">
<a href="readme.html" class="bottom-actions-button" rel="next">
<span class="subheader">
Next Page →
</span>
<span class="title">
Template Generator
</span>
</a>
</div>
</div>
<footer class="footer">
<p>
On Hex.pm:
<span class="line">
<a href="https://hex.pm/packages/template_generator/0.1.0" class="line footer-hex-package">Package</a>
<a href="https://preview.hex.pm/preview/template_generator/0.1.0" class="line">Preview</a>
</span>
<button class="line footer-button display-quick-switch">
Search
</button>
</p>
<p>
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.28.3) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>