GithubHelp home page GithubHelp logo

yuidoc-bootstrap-theme's Introduction

yuidoc-bootstrap-theme

A revamped yuidoc theme with bootstrap

When running yuidoc from command line: -t : themedir -H : helper js file

Ex.

yuidoc -t _location_/yuidoc-bootstrap-theme -H _location_/yuidoc-bootstrap-theme/helpers/helpers.js

When running with grunt it is best to use this as a submodule.

Then under yuidoc.json options add:

"themedir" : _location_/yuidoc-bootstrap-theme,
"helpers" : [ _location_/yuidoc-bootstrap-theme/helpers/helpers.js ]

Ex.

{
    "name": "Example",
    "url": "www.example.com",
    "version": "0.1.0",
    "options": {
        "paths": "_location to parse_",
        "outdir": "build/docs",
        "exclude": "lib,docs,build",
        "themedir": "_location_/yuidoc-bootstrap-theme",
        "helpers": ["_location_/yuidoc-bootstrap-theme/helpers/helpers.js"]
    }
}

yuidoc-bootstrap-theme's People

Contributors

tonybaroneee avatar kevinlacotaco avatar lfryc avatar

Watchers

JT5D avatar James Cloos 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.