yuidoc-asp

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>YUIDoc Themes</title> <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Maven+Pro:400,700"> <link rel="stylesheet" href="http://yui.yahooapis.com/3.4.1/build/cssgrids/grids-min.css"> <link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> <link rel="icon" href="../assets/favicon.ico"> <script src="http://yui.yahooapis.com/3.5.1/build/yui/yui.js"></script> </head> <body> <a href="https://github.com/yui/yuidoc"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a> <div id="doc"> <div id="hd"> <h1><img src="http://yuilibrary.com/img/yui-logo-2x.png" width="117" height="52">YUIDoc Themes</h1> </div> <div class="crumbs"> <a href="../">Main Page</a> <a name="Arrow">></a> <a href="../themes/index.html">YUIDoc Themes</a> </div> <a href="#toc" class="jump">Jump to Table of Contents</a> <div class="yui3-g"> <div class="yui3-u-3-4"> <div id="main"> <div class="content"><p> YUIDoc uses <a href="http://handlebarsjs.com/">Handlebars.js</a> to render its templates. For easy customization, YUIDoc's default templates provide a specific set of file overrides. </p> <h2 id="directories">Directories</h2> <p> The default theme consists of <code>assets/</code>, <code>layouts/</code> and <code>partials/</code> directories, along with a <code>theme.json</code> file that describes theme-related variables, such as the JS and CSS to load. </p> <pre class="code terminal">themes/ default/ assets/ //Project assets, css, js layouts/ *.handlebars //Handlebars files for layouts partials/ *.handlebars //Handlebars files for partials theme.json //JSON file with theme variables</pre> <h3 id="layouts">Layouts</h3> <p> A YUIDoc template has two primary layout files: <code>main.handlebars</code> and <code>xhr.handlebars</code>. </p> <table> <tr> <th><code>main</code></th> <td> Provides a complete wrapper around every rendered page. <code>main.handlebars</code> includes the full HTML header and footer markup, CSS, and JS for every YUIDoc API page. </td> </tr> <tr> <th><code>xhr</code></th> <td> Provides a smaller layout for the built-in doc server to use when requesting an individual page via XHR. This enables the browser to refresh just the content pane and avoid loading the complete markup for the entire page. The <code>xhr</code> template enables YUIDoc to progressively enhance the API documentation in an efficient manner. </td> </tr> </table> <h3 id="partials">Partials</h3> <p> For each section of the layout that derives from parsed YUIDoc comment data, YUIDoc provides a Handlebars partial. </p> <table> <tr> <th><code>index</code></th> <td>Renders the main index content.</td> </tr> <tr> <th><code>sidebar</code></th> <td>Renders the tabview containing the lists of classes and modules.</td> </tr> <tr> <th><code>options</code></th> <td>Renders the filter options at the top of the page, which enable the user to hide and show private methods, inherited methods, and so on.</td> </tr> <tr> <th><code>attrs</code></th> <td>Renders documentation for an individual YUI Attribute.</td> </tr> <tr> <th><code>classes</code></th> <td>Renders documentation for an individual class.</td> </tr> <tr> <th><code>events</code></th> <td>Renders documentation for an individual event.</td> </tr> <tr> <th><code>files</code></th> <td>Renders the API's source files.</td> </tr> <tr> <th><code>method</code></th> <td>Renders documentation for an individual method.</td> </tr> <tr> <th><code>module</code></th> <td>Renders documentation for an individual module.</td> </tr> <tr> <th><code>props</code></th> <td>Renders documentation for an individual property.</td> </tr> </table> <h2 id="overriding-a-partiallayout">Overriding a Partial/Layout</h2> <p> YUIDoc's <code>--themedir</code> option specifies a directory containing layouts and partials that override the default theme. For example: </p> <pre class="code terminal"><span class="noselect">$ </span>yuidoc --themedir ./mytheme</pre> <p> causes YUIDoc to inspect the directory <code>./mytheme</code> for template overrides. If this directory contains an override such as <code>./mytheme/partials/method.handlebars</code>, YUI will parse its internal templates first, then apply the custom <code>method.handlebars</code> partial. If a theme has no explicit override for a given template file, YUIDoc simply falls back to using the default layout or partial. </p> </div> </div> </div> <div class="yui3-u-1-4"> <div class="sidebar"> <ul class="links"> <li><a href="https://github.com/yui/yuidoc/" class="button">Get the Source</a></li> <li><a href="https://groups.google.com/forum/#!forum/yuidoc" class="button">Questions? Join the Mailing List</a></li> <li><a href="https://github.com/yui/yuidoc/issues/" class="button">File an Issue</a></li> <li><a href="../api/" class="button">View API Documentation</a></li> </ul> <div class="sidebox"> <div class="hd"> <h2 class="no-toc">Build Status</h2> </div> <div class="bd"> <a href="http://travis-ci.org/yui/yuidoc"><img src="https://secure.travis-ci.org/yui/yuidoc.png?branch=master" border="0"></a> </div> </div> <div id="toc" class="sidebox"> <div class="hd"> <h2 class="no-toc">Table of Contents</h2> </div> <div class="bd"> <ul class="toc"> <li> <a href="#directories">Directories</a> <ul class="toc"> <li> <a href="#layouts">Layouts</a> </li> <li> <a href="#partials">Partials</a> </li> </ul> </li> <li> <a href="#overriding-a-partiallayout">Overriding a Partial/Layout</a> </li> </ul> </div> </div> </div> </div> </div> </div> <script src="../assets/vendor/prettify/prettify-min.js"></script> <script>prettyPrint();</script> </body> </html>