GithubHelp home page GithubHelp logo

ember-cli-yuidoc-converter's Introduction

And ember-cli addon used by https://github.com/trek/ember-api to preprocesses the JSON data emitted by YUIDoc, which is fairly tightly coupled to their page generation needs.

This takes a YUIDoc data JSON object and emits an directory/file structure like this:

  // Containing a list of all classes, namespaces, and modules by name property.
  index.json

  // for every class/namespace:
  KlassName.json
  KlassName/
    index.json
    methods.json
    properties.json
    events.json

  // for every module
  modules/
    module-name.json
    other-module-name.json

This can then be read by a web application later.

Ideally some day we'd write a pluggable markdown-based documentation tool that only emits a sensible JSON structure and leave file generation up to the consumer (i.e. does on thing well).

ember-cli-yuidoc-converter's People

Contributors

ember-tomster avatar gregone avatar raido avatar rwjblue avatar trek avatar

Watchers

 avatar  avatar  avatar

ember-cli-yuidoc-converter's Issues

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.