Foundation for Emails editable vendor lib

This commit is contained in:
Derek Montgomery
2016-08-15 08:31:39 -05:00
committed by Mark Moser
parent d5d15b3537
commit c628fa58a0
97 changed files with 8697 additions and 24 deletions

View File

@ -0,0 +1,314 @@
<article class="docs-component" id="docs-{{escape title}}">
<h1 class="docs-page-title">{{ title }}</h1>
<p class="lead docs-page-lead">{{ description }}</p>
<hr>
{{!-- Start container for docs and table of contents --}}
<div class="row">
{{!-- Start container for table of contents --}}
<nav>
<div class="large-3 large-push-9 columns">
<ul class="vertical menu docs-sub-menu" data-docs-toc>
<li class="docs-menu-title">On this page:</li>
</ul>
<ul class="vertical menu docs-sub-menu">
<li class="docs-menu-title">Contribute:</li>
<li><a href="{{ editLink fileName }}">Edit this Page</a></li>
<li><a href="{{ issueLink title }}">Report a Bug</a></li>
{{ sourceLink _adapterData }}
</ul>
</div>
</nav>
{{!-- End container for table of contents --}}
{{!-- Start container for docs --}}
<div class="large-9 large-pull-3 columns">
{{ docs }}
{{#if sass}}
<hr>
<section>
{{#heading 2}}Sass Reference{{/heading}}
{{#if sass.variable}}
<section>
{{#heading 3 'sass-variables'}}Variables{{/heading}}
<p>The default styles of this component can be customized using these Sass variables in your project's <a href="sass.html#the-settings-file">settings file</a>.</p>
<table class="docs-variable-table">
<thead>
<tr><th>Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr>
</thead>
{{#each sass.variable}}
<tr>
<td class="name"><code>${{this.context.name}}</code></td>
<td>{{sassTypes this.type}}</td>
<td class="{{toLower this.type}}"><code>{{sassValue this.context.value}}</code></td>
<td>{{md this.description}}</td>
</tr>
{{/each}}
</table>
</section>
{{/if}}
{{#if sass.mixin}}
{{#if sass.variable}}<hr>{{/if}}
<section>
{{#heading 3 'sass-mixins'}}Mixins{{/heading}}
<p>We use these mixins to build the final CSS output of this component. You can use the mixins yourself to build your own class structure out of our components.</p>
{{#each sass.mixin}}
<section {{#if this.deprecated }}class="docs-deprecated"{{/if}}>
{{#heading 4}}{{this.context.name}}{{/heading}}
{{#if this.since}}
<p class="docs-notice-added">Added in {{this.since.0.version}}</p>
{{/if}}
{{#if this.deprecated}}
<p class="docs-notice-deprecated">Deprecated in {{this.deprecated}}</p>
{{/if}}
<div class="docs-code">
<pre><code>{{writeMixin this}}</code></pre>
</div>
{{md this.description}}
{{externalLink this.link}}
{{#if this.parameter}}
<table class="docs-variable-table">
<thead>
<tr><th>Parameter</th><th>Type</th><th>Default Value</th><th>Description</th></tr>
</thead>
{{#each this.parameter}}
<tr>
<td><code>${{this.name}}</code></td>
<td>{{sassTypes this.type}}</td>
<td><code>{{sassValue this.default}}</code></td>
<td>{{md this.description}}</td>
</tr>
{{/each}}
</table>
{{/if}}
</section>
{{#unless @last}}<hr>{{/unless}}
{{#if sass.function}}
<hr>
{{/if}}
{{/each}}
</section>
{{/if}}
{{#if sass.function}}
<hr>
<section>
{{#heading 3 'sass-functions'}}Functions{{/heading}}
{{#each sass.function}}
<section {{#if this.deprecated }}class="docs-deprecated"{{/if}}>
{{#heading 4}}{{this.context.name}}{{/heading}}
{{#if this.since}}
<p class="docs-notice-added">Added in {{this.since.0.version}}</p>
{{/if}}
{{#if this.deprecated}}
<p class="docs-notice-deprecated">Deprecated in {{this.deprecated.version}}</p>
{{/if}}
<div class="docs-code">
<pre><code>{{writeFunction this}}</code></pre>
</div>
{{md this.description}}
{{externalLink this.link}}
{{#if this.parameter}}
<table class="docs-variable-table">
<thead>
<tr><th>Parameter</th><th>Type</th><th>Default Value</th><th>Description</th></tr>
</thead>
{{#each this.parameter}}
<tr>
<td><code>${{this.name}}</code></td>
<td>{{sassTypes this.type}}</td>
<td><code>{{sassValue this.default}}</code></td>
<td>{{md this.description}}</td>
</tr>
{{/each}}
</table>
{{/if}}
</section>
{{#unless @last}}<hr>{{/unless}}
{{/each}}
</section>
{{/if}}
</section>
{{/if}}
{{#if js}}
<hr>
<section>
{{#heading 2}}JavaScript Reference{{/heading}}
{{#each js.class}}
<section>
{{#heading 3 'js-class'}}Foundation.{{this.name}}{{/heading}}
{{md this.description}}
<div class="docs-code"><pre><code>var elem = new Foundation.{{this.name}}(element, options);</code></pre></div>
{{#if this.fires}}
<p><strong>Fires these events:</strong>
{{#each this.fires}}
{{this}}
{{/each}}
</p>
{{/if}}
{{#if this.params}}
<table class="docs-variable-table">
<thead>
<tr><th>Name</th><th>Type</th><th>Description</th></tr>
</thead>
{{#each this.params}}
<tr>
<td><code>{{this.name}}</code></td>
<td>{{this.type.names.[0]}}</td>
<td>{{this.description}}</td>
</tr>
{{/each}}
</table>
{{/if}}
</section>
{{/each}}
<hr>
{{#if js.member}}
<section>
{{#heading 3 'js-options'}}Plugin Options{{/heading}}
<p>Use these options to customize an instance of {{title}}. Plugin options can be set as individual data attributes, one combined <code>data-options</code> attribute, or as an object passed to the plugin's constructor. <a href="#">Learn more about how JavaScript plugins are initialized.</a></p>
<table class="docs-variable-table">
<thead>
<tr><th>Name</th><th>Description</th><th>Example</th></tr>
</thead>
{{#each js.member}}
<tr>
<td>{{this.name}}</td>
<td>{{this.description}}</td>
<td><code>Sample!</code></td>
</tr>
{{/each}}
</table>
</section>
{{/if}}
<hr>
{{#if js.event}}
<section>
{{#heading 3 'js-events'}}Events{{/heading}}
<p>These events will fire from any element with a {{title}} plugin attached.</p>
<table class="docs-variable-table">
<thead>
<tr><th>Name</th><th>Description</th></tr>
</thead>
{{#each js.event}}
<tr>
<td>{{this.name}}.zf.{{../title}}</td>
<td>{{this.description}}</td>
</tr>
{{/each}}
</table>
</section>
{{/if}}
<hr>
{{#if js.function}}
<section>
{{#heading 3 'js-functions'}}Functions{{/heading}}
{{#each js.function}}
<section>
{{#heading 4 'js-class'}}{{../../js.class.0.name}}.{{this.name}}{{/heading}}
{{md this.description}}
{{#if this.fires}}
<p><strong>Fires these events:</strong>
{{#each this.fires}}
{{this}}
{{/each}}
</p>
{{/if}}
{{#if this.params}}
<table class="docs-variable-table">
<thead>
<tr><th>Name</th><th>Type</th><th>Description</th></tr>
</thead>
{{#each this.params}}
<tr>
<td><code>{{this.name}}</code></td>
<td>{{this.type.names.[0]}}</td>
<td>{{this.description}}</td>
</tr>
{{/each}}
</table>
{{/if}}
{{#unless @last}}<hr>{{/unless}}
</section>
{{/each}}
</section>
{{/if}}
</section>
{{/if}}
{{#if sass}}
<hr>
<section class="docs-building-blocks">
{{#heading 2 'building-blocks'}}Building Blocks using {{title}}{{/heading}}
<p><a href="http://zurb.com/building-blocks">Building Blocks</a> is a ZURB-curated resource with useful code snippets that use Foundation components. Here are a few for this component:</p>
<div class="row up-1 medium-up-2 large-up-3" data-building-blocks>
</div>
</section>
{{/if}}
</div>
{{!-- End container for docs --}}
</div>
{{!-- End container for docs and table of contents --}}
</article>

View File

@ -0,0 +1,73 @@
<!doctype html>
<!--[if IE 9]><html class="lt-ie10" lang="en" > <![endif]-->
<html class="no-js" lang="en" dir="ltr">
<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="description" content="{{description}}">
<link rel="icon" href="assets/img/icons/favicon.ico" type="image/x-icon">
<title>Foundation for Emails 2 Docs{{#unlesspage 'index'}} | {{title}}{{/unlesspage}}</title>
<link href="assets/css/docs.css" rel="stylesheet" />
<link href="//cdnjs.cloudflare.com/ajax/libs/foundicons/3.0.0/foundation-icons.css" rel="stylesheet">
<!-- <link rel="stylesheet" href="./node_modules/motion-ui/dist/motion-ui.css" /> -->
</head>
<body class="docs-emails">
<div class="off-canvas-wrapper"><div class="off-canvas-wrapper-inner" data-off-canvas-wrapper>
{{> off-canvas}}
<div class="off-canvas-content" data-off-canvas-content>
<!-- Info Banner For Announcements or Links -->
<!-- <a href="http://zurb.com/article/1416/foundation-6-is-here" id="notice">
<div class="info">
<h5>Foundation 6 is here!</h5>
</div>
</a> -->
{{> navigation}}
{{> mobile-navigation}}
<input type="text" class="docs-search" data-docs-search placeholder="Find a page, component, variable, mixin, function...">
<div class="expanded row">
<div class="medium-9 large-10 medium-push-3 large-push-2 columns">
<!-- body include must be left aligned for proper indentation of docs code examples -->
{{> body}}
</div>
<div class="medium-3 large-2 medium-pull-9 large-pull-10 columns">
{{> component-list}}
{{> course-callout}}
</div>
</div>
{{> footer}}
</div>
</div></div>
<script>
var _gaq = _gaq || [];
_gaq.push(
['_setAccount', 'UA-2195009-2'],
['_trackPageview'],
['b._setAccount', 'UA-2195009-27'],
['c._setAccount', 'UA-2195009-47'],
['b._trackPageview']
);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
<script src="https://cdn.jsdelivr.net/what-input/1.2.3/what-input.min.js"></script>
<script src="https://cdn.jsdelivr.net/foundation/6.2.0/foundation.min.js"></script>
<script src="https://cdn.jsdelivr.net/typeahead.js/0.11.1/typeahead.bundle.min.js"></script>
<script src="https://cdn.jsdelivr.net/clipboard.js/1.5.9/clipboard.min.js"></script>
<script src="assets/js/docs.js"></script>
</body>
</html>