From: Nick Wittwer Date: Tue, 23 Aug 2016 11:09:33 +0000 (-0700) Subject: Added sidebar icons, fixed Markdown bug X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0b1c77eca812bcb37bf881a4872802c45edf6f20;p=thirdparty%2Ffoundation%2Ffoundation-emails.git Added sidebar icons, fixed Markdown bug --- diff --git a/docs/layouts/component.html b/docs/layouts/component.html index e503ab0a..382cddd1 100644 --- a/docs/layouts/component.html +++ b/docs/layouts/component.html @@ -1,314 +1,314 @@
-

{{ title }}

- -

{{ description }}

- -
- -{{!-- Start container for docs and table of contents --}} -
- -{{!-- Start container for table of contents --}} - -{{!-- End container for table of contents --}} - -{{!-- Start container for docs --}} -
- -{{ docs }} - -{{#if sass}} -
- -
- {{#heading 2}}Sass Reference{{/heading}} - - {{#if sass.variable}} -
- {{#heading 3 'sass-variables'}}Variables{{/heading}} - -

The default styles of this component can be customized using these Sass variables in your project's settings file.

- - - - - - {{#each sass.variable}} - - - - - - - {{/each}} -
NameTypeDefault ValueDescription
${{this.context.name}}{{sassTypes this.type}}{{sassValue this.context.value}}{{md this.description}}
-
- {{/if}} - - {{#if sass.mixin}} - {{#if sass.variable}}
{{/if}} - -
- {{#heading 3 'sass-mixins'}}Mixins{{/heading}} - -

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.

+

{{ title }}

- {{#each sass.mixin}} -
- {{#heading 4}}{{this.context.name}}{{/heading}} +

{{ description }}

- {{#if this.since}} -

Added in {{this.since.0.version}}

- {{/if}} - - {{#if this.deprecated}} -

Deprecated in {{this.deprecated}}

- {{/if}} +
-
- 
{{writeMixin this}}
+ {{!-- Start container for docs and table of contents --}} +
+ + {{!-- Start container for table of contents --}} + + {{!-- End container for table of contents --}} - {{md this.description}} - - {{externalLink this.link}} - - {{#if this.parameter}} - - - - - {{#each this.parameter}} - - - - - - - {{/each}} -
ParameterTypeDefault ValueDescription
${{this.name}}{{sassTypes this.type}}{{sassValue this.default}}{{md this.description}}
- {{/if}} -
+ {{!-- Start container for docs --}} +
- {{#unless @last}}
{{/unless}} +{{ docs }} - {{#if sass.function}} + {{#if sass}}
- {{/if}} - - {{/each}} -
- {{/if}} - - {{#if sass.function}} -
- -
- {{#heading 3 'sass-functions'}}Functions{{/heading}} - {{#each sass.function}} -
- {{#heading 4}}{{this.context.name}}{{/heading}} - - {{#if this.since}} -

Added in {{this.since.0.version}}

- {{/if}} - - {{#if this.deprecated}} -

Deprecated in {{this.deprecated.version}}

+
+ {{#heading 2}}Sass Reference{{/heading}} + + {{#if sass.variable}} +
+ {{#heading 3 'sass-variables'}}Variables{{/heading}} + +

The default styles of this component can be customized using these Sass variables in your project's settings file.

+ + + + + + {{#each sass.variable}} + + + + + + + {{/each}} +
NameTypeDefault ValueDescription
${{this.context.name}}{{sassTypes this.type}}{{sassValue this.context.value}}{{md this.description}}
+
+ {{/if}} + + {{#if sass.mixin}} + {{#if sass.variable}}
{{/if}} + +
+ {{#heading 3 'sass-mixins'}}Mixins{{/heading}} + +

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.

+ + {{#each sass.mixin}} +
+ {{#heading 4}}{{this.context.name}}{{/heading}} + + {{#if this.since}} +

Added in {{this.since.0.version}}

+ {{/if}} + + {{#if this.deprecated}} +

Deprecated in {{this.deprecated}}

+ {{/if}} + +
+ 
{{writeMixin this}}
+
+ + {{md this.description}} + + {{externalLink this.link}} + + {{#if this.parameter}} + + + + + {{#each this.parameter}} + + + + + + + {{/each}} +
ParameterTypeDefault ValueDescription
${{this.name}}{{sassTypes this.type}}{{sassValue this.default}}{{md this.description}}
+ {{/if}} +
+ + {{#unless @last}}
{{/unless}} + + {{#if sass.function}} +
+ {{/if}} + + {{/each}} +
+ {{/if}} + + {{#if sass.function}} +
+ +
+ {{#heading 3 'sass-functions'}}Functions{{/heading}} + + {{#each sass.function}} +
+ {{#heading 4}}{{this.context.name}}{{/heading}} + + {{#if this.since}} +

Added in {{this.since.0.version}}

+ {{/if}} + + {{#if this.deprecated}} +

Deprecated in {{this.deprecated.version}}

+ {{/if}} + +
+ 
{{writeFunction this}}
+
+ + {{md this.description}} + + {{externalLink this.link}} + + {{#if this.parameter}} + + + + + {{#each this.parameter}} + + + + + + + {{/each}} +
ParameterTypeDefault ValueDescription
${{this.name}}{{sassTypes this.type}}{{sassValue this.default}}{{md this.description}}
+ {{/if}} +
+ + {{#unless @last}}
{{/unless}} + {{/each}} +
+ {{/if}} + +
{{/if}} -
- 
{{writeFunction this}}
-
+ {{#if js}} +
- {{md this.description}} - - {{externalLink this.link}} - - {{#if this.parameter}} - - - - - {{#each this.parameter}} - - - - - - +
+ {{#heading 2}}JavaScript Reference{{/heading}} + + {{#each js.class}} +
+ {{#heading 3 'js-class'}}Foundation.{{this.name}}{{/heading}} + + {{md this.description}} + + 
var elem = new Foundation.{{this.name}}(element, options);
+ + {{#if this.fires}} +

Fires these events: + {{#each this.fires}} + {{this}} + {{/each}} +

+ {{/if}} + + {{#if this.params}} +
ParameterTypeDefault ValueDescription
${{this.name}}{{sassTypes this.type}}{{sassValue this.default}}{{md this.description}}
+ + + + {{#each this.params}} + + + + + + {{/each}} +
NameTypeDescription
{{this.name}}{{this.type.names.[0]}}{{this.description}}
+ {{/if}} +
{{/each}} - - {{/if}} -
- - {{#unless @last}}
{{/unless}} - {{/each}} -
- {{/if}} - - -{{/if}} - -{{#if js}} -
- -
- {{#heading 2}}JavaScript Reference{{/heading}} - - {{#each js.class}} -
- {{#heading 3 'js-class'}}Foundation.{{this.name}}{{/heading}} - - {{md this.description}} - - 
var elem = new Foundation.{{this.name}}(element, options);
- - {{#if this.fires}} -

Fires these events: - {{#each this.fires}} - {{this}} - {{/each}} -

- {{/if}} - - {{#if this.params}} - - - - - {{#each this.params}} - - - - - - {{/each}} -
NameTypeDescription
{{this.name}}{{this.type.names.[0]}}{{this.description}}
- {{/if}} -
- {{/each}} - -
- - {{#if js.member}} -
- {{#heading 3 'js-options'}}Plugin Options{{/heading}} - -

Use these options to customize an instance of {{title}}. Plugin options can be set as individual data attributes, one combined data-options attribute, or as an object passed to the plugin's constructor. Learn more about how JavaScript plugins are initialized.

- - - - - - {{#each js.member}} - - - - - - {{/each}} -
NameDescriptionExample
{{this.name}}{{this.description}}Sample!
-
- {{/if}} - -
- - {{#if js.event}} -
- {{#heading 3 'js-events'}}Events{{/heading}} - -

These events will fire from any element with a {{title}} plugin attached.

- - - - - - {{#each js.event}} - - - - - {{/each}} -
NameDescription
{{this.name}}.zf.{{../title}}{{this.description}}
-
- {{/if}} -
+
+ + {{#if js.member}} +
+ {{#heading 3 'js-options'}}Plugin Options{{/heading}} + +

Use these options to customize an instance of {{title}}. Plugin options can be set as individual data attributes, one combined data-options attribute, or as an object passed to the plugin's constructor. Learn more about how JavaScript plugins are initialized.

+ + + + + + {{#each js.member}} + + + + + + {{/each}} +
NameDescriptionExample
{{this.name}}{{this.description}}Sample!
+
+ {{/if}} + +
+ + {{#if js.event}} +
+ {{#heading 3 'js-events'}}Events{{/heading}} + +

These events will fire from any element with a {{title}} plugin attached.

+ + + + + + {{#each js.event}} + + + + + {{/each}} +
NameDescription
{{this.name}}.zf.{{../title}}{{this.description}}
+
+ {{/if}} + +
+ + {{#if js.function}} +
+ {{#heading 3 'js-functions'}}Functions{{/heading}} + + {{#each js.function}} +
+ {{#heading 4 'js-class'}}{{../../js.class.0.name}}.{{this.name}}{{/heading}} + + {{md this.description}} + + {{#if this.fires}} +

Fires these events: + {{#each this.fires}} + {{this}} + {{/each}} +

+ {{/if}} + + {{#if this.params}} + + + + + {{#each this.params}} + + + + + + {{/each}} +
NameTypeDescription
{{this.name}}{{this.type.names.[0]}}{{this.description}}
+ {{/if}} + + {{#unless @last}}
{{/unless}} +
+ {{/each}} +
+ {{/if}} +
+ {{/if}} - {{#if js.function}} -
- {{#heading 3 'js-functions'}}Functions{{/heading}} + {{#if sass}} +
- {{#each js.function}} -
- {{#heading 4 'js-class'}}{{../../js.class.0.name}}.{{this.name}}{{/heading}} +
+ {{#heading 2 'building-blocks'}}Building Blocks using {{title}}{{/heading}} - {{md this.description}} +

Building Blocks is a ZURB-curated resource with useful code snippets that use Foundation components. Here are a few for this component:

- {{#if this.fires}} -

Fires these events: - {{#each this.fires}} - {{this}} - {{/each}} -

- {{/if}} +
- {{#if this.params}} - - - - - {{#each this.params}} - - - - - - {{/each}} -
NameTypeDescription
{{this.name}}{{this.type.names.[0]}}{{this.description}}
+
+
{{/if}} - {{#unless @last}}
{{/unless}} -
- {{/each}} -
- {{/if}} - -{{/if}} +
+ {{!-- End container for docs --}} -{{#if sass}} -
- -
- {{#heading 2 'building-blocks'}}Building Blocks using {{title}}{{/heading}} - -

Building Blocks is a ZURB-curated resource with useful code snippets that use Foundation components. Here are a few for this component:

- -
-
-
-{{/if}} - -
-{{!-- End container for docs --}} - - -{{!-- End container for docs and table of contents --}} + {{!-- End container for docs and table of contents --}}
diff --git a/docs/layouts/default.html b/docs/layouts/default.html index cce147d0..217e7377 100644 --- a/docs/layouts/default.html +++ b/docs/layouts/default.html @@ -16,7 +16,7 @@
- {{> off-canvas}} +{{> off-canvas}}
@@ -26,20 +26,20 @@
--> - {{> navigation}} - {{> mobile-navigation}} +{{> navigation}} +{{> mobile-navigation}} - {{> docs-header}} +{{> docs-header}}
- {{> body}} +{{> body}}
- {{> sidebar}} +{{> sidebar}}
- {{> footer}} +{{> footer}}
diff --git a/docs/partials/component-list.html b/docs/partials/component-list.html index 94b40e6e..d2ee22a2 100644 --- a/docs/partials/component-list.html +++ b/docs/partials/component-list.html @@ -1,11 +1,11 @@