Git Product home page Git Product logo

yuidoc-adsy-theme's Introduction

Adfinis SyGroup YUIDoc Theme

A YUIDoc theme, which considers our company standards and uses our company CSS framework (AdCSSy).

Limitations

  • No elements
  • No attributes
  • Can't remember access options after page refresh
  • Descriptions from external sources are not rendered properly (bug in YUIDoc)

Installation

Install yuidoc-adsy-theme from npm:

npm install yuidoc-adsy-theme

Adjust your options in yuidoc.json to:

{
  "options": {
    "themedir": "node_modules/yuidoc-adsy-theme",
    "helpers": [
      "node_modules/yuidoc-adsy-theme/helpers/helpers.js"
    ]
  }
}

Testing

You can build the example documentation with npm test or watch it with npm start.

License

MIT see LICENSE.

yuidoc-adsy-theme's People

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

yuidoc-adsy-theme's Issues

Add proper example

Add a proper API documentation as example and publish it on github pages.

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.