Code Monkey home page Code Monkey logo

api-tool's Introduction

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"}
]

api-tool's People

Contributors

unwiredben avatar dfreedm avatar andrewrichpalm avatar micro-tech avatar sjmiles avatar

Stargazers

Michael Anthony avatar

Watchers

Michael Anthony avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.