GithubHelp home page GithubHelp logo

jsxgraph / yuidoc Goto Github PK

View Code? Open in Web Editor NEW

This project forked from yui/yuidoc

0.0 4.0 0.0 5.12 MB

YUI Javascript Documentation Tool

Home Page: http://yui.github.com/yuidoc

License: Other

Makefile 0.01% CSS 3.55% HTML 51.34% JavaScript 45.03% Shell 0.05% CoffeeScript 0.02%

yuidoc's Introduction

YUIDoc

YUI's JavaScript Documentation engine.

npm Version Build Status Dependency Status

Overview

YUIDoc is a Node.js application used at build time to generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide range of JavaScript coding styles. The output of YUIDoc is API documentation formatted as a set of HTML pages including information about methods, properties, custom events and inheritance for JavaScript objects.

YUIDoc was originally written for the YUI Project; it uses YUI JavaScript and CSS in the generated files and it supports common YUI conventions like Custom Events. That said, it can be used easily and productively on non-YUI code.

Installation

npm install -g yuidocjs

Documentation

Contributing

Please see the CONTRIBUTING.md.

License

This software is free to use under the Yahoo Inc. BSD license. See the LICENSE file for license text and copyright information.

yuidoc's People

Contributors

andrewnicols avatar andyearnshaw avatar bakfr avatar caridy avatar codelulu avatar davglass avatar derek avatar dtan avatar ericf avatar erikabele avatar evangoer avatar floydpink avatar hokaccha avatar isaachier avatar lexander avatar limikael avatar mikepmunroe avatar mmpestorich avatar okuryu avatar onlywei avatar prodaea avatar reid avatar rgrove avatar sdesai avatar spartanp avatar spocke avatar thomasboyt avatar timdp avatar tivac avatar yyjdelete avatar

Watchers

avatar avatar 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.