Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.04 KB

README.md

File metadata and controls

31 lines (24 loc) · 1.04 KB
Raw

EnyoJS API Tool

This Bootplate-based application scans EnyoJS source code on the fly and produces navigable documentation.

The assets/manifest.json file identifies the code packages to be scanned. You can edit this file in your local copy of the api-tool to add your own packages and libraries to your local view of the documentation. When we deploy this to the enyojs.com website, we use a modified version of the manifest to include all of the Enyo standard libraries.

IMPORTANT: in the context of the API Tool application, the $enyo and $libmacros refer to internal folders used to run the app. You should not use those macros in assets/manifest.json in a deployed API Tool application. Instead, use complete paths, either relative to the API Tool folder, or absolute.

For example, given:

enyo/
lib/
  layout/
api-tool/

manifest.json should look like this:

[
	{"name": "enyo", "path": "../enyo/source"}
	{"name": "layout", "path": "../lib/layout"}
]