Skip to content
Documentation for Enyo and its libraries
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Add link to sampler to link bar Jan 5, 2015
developer-guide Added migration guides to the docs Jan 29, 2016
ext allow glossary link handling to be done at the same time as standard … Aug 25, 2014
lib ENYO-1376 Preent error in jsdoc comment from aborting build Apr 9, 2015
tasks Update to use local install of jsdoc Jan 9, 2015
templates
.bowerrc interim commit adding in grunt as entry point Aug 18, 2014
.gitignore
.jshintrc Added .jshintrc Nov 10, 2014
DOCUMENTATION-LICENSE.txt Added Creative Commons Attribution license Dec 29, 2014
Gruntfile.js Added a task to build developer guide Dec 23, 2014
LICENSE-2.0.txt
README.md
bower.json Added jquery dependency to bower.json Nov 10, 2014
code-standard-wip.md more formatting updates Jul 8, 2014
env.sh Update to use local install of jsdoc Jan 9, 2015
enyo-jsdoc-syntax.md add syntax file for further documenting enyo-isms Aug 26, 2014
jsdoc-conf.json
package.json ENYO-1136 Docs not compatible to Mar 20, 2015
publish.js
test.conf initial commit for repurposed repository Jul 21, 2014
test.js initial commit for repurposed repository Jul 21, 2014

README.md

#Enyo.js API Reference Generator

The purpose of this project is to coordinate the accumulation and generation of the API documentation reference for enyo and its public libraries. It accomplishes this by leveraging available technologies, including itself, according to the limitations of its requirements at the time it was originally authored.

In the future, my hope is that the project will be able to better fulfill its ultimate purpose by coordinating all documentation and developer guidance into a single, normalized and cohesive source that is performant, extensible and comprehensive. For now, that is not possible.

System requirements

The developer guide requires a unix-y shell. If you wish to build the full docs you will need Linux or Mac OS X. If you're feeling adventurous, you can convert the shell task into a grunt task (possibly with grunt-pandoc or one of the pandoc node modules.

Technologies

Required Core Technologies
  • Node.js - Everything relies on node
  • npm - Package manager for Node.js (installed with node)
  • pandoc - A universal document converter, used to convert markdown to HTML. Be sure to make available on your path if it is not. (tip: 'brew install pandoc' on Mac)
Global npm Requirements
  • Grunt.js - Command line client: npm install -g grunt-cli
  • Bower - Dependency management tool: npm install -g bower
Incorporated Technologies

Execute npm install and then bower install in the enyo-docs directory to install these additional requirements:

  • JSdoc3 - The backbone of our documentation syntax and parser/generator
  • Nunjucks - The templating engine used to generate static HTML content
  • Grunt.js - Task runner to help automate certain portions of generating and building the site
  • Prism.js - The code/syntax highlighter in the output
  • JQuery - The runtime progressive-enhancement JavaScript library used to interact with the static DOM

File System Setup

The enyo-docs scripts assume that enyo and its libraries will be siblings and the libraries will be in the lib directory in the standard Bootplate way. In other words:

Parent
+- enyo-docs
+- enyo
+- lib
	+- onyx
	+- layout
	+- moonstone
	+- canvas
	+- spotlight

Directories to be scanned (and other options for jsDoc) can be found in jsdoc-conf.json

Building The Docs

To build the docs, simply execute grunt in the enyo-docs directory:

grunt

Generated docs go into the output directory.

Additional notes

Two special 'macros' are used within the enyo docs source:

  • $api - Converted into the relative location of the root document directory. Used primarily in the developer-guide to locate api references.
  • $dev-guide - Converted into the relative location of the developer guide. Used primarily in the enyo source to point towards the developer guide articles.
You can’t perform that action at this time.