hansuxdev / foundation-docs

Common templates and utilities for the Foundation family documentation.

Foundation Docs

This is a set of HTML templates and JavaScript utilities shared by the documentation pages for the Foundation family of frameworks, including:

• Foundation for Sites
• Foundation for Apps
• Foundation for Emails

Installation

npm install foundation-docs --save-dev

JavaScript Usage

When you require() the foundation-docs library, you get access to a handful of JavaScript libraries, as well as file paths to HTML templates.

foundationDocs.buildSearch

Generates a JSON file for use with the docs search function. Best used with the component tree generated by Supercollider.

Parameters:

• tree (Object): tree of components to build pages from.
• cb (Function): callback to run once the finished JSON file has been written to disk.

var foundationDocs = require('foundation-docs');

foundationDocs.buildSearch(supercollider.tree, cb);

foundationDocs.handlebars

An instance of a custom Handlebars renderer with all the helpful functions we need to generate documentation.

foundationDocs.marked

An instance of a custom Marked renderer, which has two custom functions:

• When headings are written, an anchor icon is added to the left of the heading text.
• When code samples are written:
  • If the language is html_example, a live rendering of the HTML in the sample is added.
  • If the language is inky_example, a live rendering of the HTML in the sample—within an iframe that loads the Ink CSS—is added.

foundationDocs.componentTemplate

A String path to the HTML template used for component pages. The general structure is:

• Title area
• Main docs (converted Markdown)
• Sass reference
• JavaScript reference
• Table of contents

The path is node_modules/foundation-docs/templates/component.html.

Sass Usage

The CSS used for the Foundation documentation is included as a series of Sass partials. Foundation and Motion UI must be loaded manually before it.

@import 'foundation';
@import 'motion-ui';

@include foundation-everything;
@include motion-ui-transitions;

@import 'foundation-docs';