Fix titles in API docs (via new Panino)
This commit is contained in:
Garen Torikian
parent
55d57fd30d
commit
e4aa77dc3f
21 changed files with 45 additions and 30 deletions
|
|
@ -1,7 +1,7 @@
|
|||
<!DOCTYPE html><!--[if lt IE 7]> <html class="no-js ie6 oldie" lang="en"> <![endif]-->
|
||||
<!--[if IE 7]> <html class="no-js ie7 oldie" lang="en"> <![endif]-->
|
||||
<!--[if IE 8]> <html class="no-js ie8 oldie" lang="en"> <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]--><html xmlns="http://www.w3.org/1999/xhtml"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"><title>Ace API - /Users/gjtorikian/Developer/ace/lib/ace/ace.js</title><meta name="generator" content="c9-doc-build"><meta name="description" content="Ace API documentation for the online code editor."><meta name="author" content="Garen J. Torikian"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="./resources/csses/bootstrap.min.css"><link rel="stylesheet" href="./resources/csses/prettify.css"><link rel="stylesheet" href="./resources/csses/ace_api.css"><link href="./resources/images/favicon.ico" rel="icon" type="image/x-icon"><script src="./resources/javascripts/jquery.js"></script><script src="./resources/javascripts/clicker.js"></script><script src="./resources/javascripts/jquery.collapse.js"></script><script src="./resources/javascripts/jquery.cookie.js"></script><script src="./resources/javascripts/bootstrap-dropdown.js"></script><script src="./resources/javascripts/jquery-scrollspy.js"></script><script script src="./resources/javascripts/prettify-extension.js"></script></head><body><div class="navbar navbar-fixed-top"><div class="navbar-inner"><div id="topSection" class="container"><span class="brand"></span><ul class="nav topLinks"><li id="ace_site"><a href="../index.html">Ace</a></li><li id="ace_api" class="active"><a href="index.html">Ace API Reference</a></li></ul><form id="searchbox" action="" class="navbar-search pull-right"> <input name="query" type="text" placeholder="Search the API" title="Search across all the documentation" class="search-query span3"></form></div></div></div><div id="nonFooter"><div id="wrapper"><div class="content"><div class="row centerpiece"><div id="sidebarContainer" class="span3"><div id="sidebar"><div id="well"><h3>Ace Reference</h3><div class="swirl_divider"> </div><ul class="menu"><li><div class="menu-item"><a href="ace.html" class="menuLink namespace">Ace</a></div></li><li><div class="menu-item"><a href="anchor.html" class="menuLink namespace">Anchor</a></div></li><li><div class="menu-item"><a href="background_tokenizer.html" class="menuLink namespace">BackgroundTokenizer </a></div></li><li><div class="menu-item"><a href="document.html" class="menuLink namespace">Document </a></div></li><li><div class="menu-item"><a href="edit_session.html" class="menuLink namespace">EditSession </a></div></li><li><div class="menu-item"><a href="editor.html" class="menuLink namespace">Editor</a></div></li><li><div class="menu-item"><a href="range.html" class="menuLink namespace">Range</a></div></li><li><div class="menu-item"><a href="scrollbar.html" class="menuLink namespace">Scrollbar</a></div></li><li><div class="menu-item"><a href="search.html" class="menuLink namespace">Search </a></div></li><li><div class="menu-item"><a href="selection.html" class="menuLink namespace">Selection </a></div></li><li><div class="menu-item"><a href="token_iterator.html" class="menuLink namespace">TokenIterator</a></div></li><li><div class="menu-item"><a href="tokenizer.html" class="menuLink namespace">Tokenizer</a></div></li><li><div class="menu-item"><a href="undomanager.html" class="menuLink namespace">UndoManager</a></div></li><li><div class="menu-item"><a href="virtual_renderer.html" class="menuLink namespace">VirtualRenderer</a></div></li></ul></div></div></div><div id="mainContent" class="span9"><div id="documentation"><div class="classContent"><div class="membersBackground"></div><div class=" members pos0"><div class=" membersContent pos0"><h1 class="memberHeader"><span class="name">Ace<span class="editInC9"><a href='http://c9.io/open/git/?url=git%3A%2F%2Fgithub.com%2Fajaxorg%2Face.git' title='Edit in Cloud9 IDE'>[edit]</a></span></span></h1><ul data-tabs="tabs" class="nav tabs pos0"><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (1)</span><b class="caret"></b></a><ul class="dropdown-menu"><li data-id="Ace.edit" class="memberLink"><a href="#Ace.edit" class="" title="Ace.edit (class method)" data-id="Ace.edit">edit</a></li></ul></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li></ul></div></div><article id="Ace" data-title="Ace (class)" class="article"><div class="section description"><div class="memberContent"><p>The main class required to set up an Ace instance in the browser.</p>
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]--><html xmlns="http://www.w3.org/1999/xhtml"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"><title>Ace - Ace API</title><meta name="generator" content="c9-doc-build"><meta name="description" content="Ace API documentation for the online code editor."><meta name="author" content="Garen J. Torikian"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="./resources/csses/bootstrap.min.css"><link rel="stylesheet" href="./resources/csses/prettify.css"><link rel="stylesheet" href="./resources/csses/ace_api.css"><link href="./resources/images/favicon.ico" rel="icon" type="image/x-icon"><script src="./resources/javascripts/jquery.js"></script><script src="./resources/javascripts/clicker.js"></script><script src="./resources/javascripts/jquery.collapse.js"></script><script src="./resources/javascripts/jquery.cookie.js"></script><script src="./resources/javascripts/bootstrap-dropdown.js"></script><script src="./resources/javascripts/jquery-scrollspy.js"></script><script script src="./resources/javascripts/prettify-extension.js"></script></head><body><div class="navbar navbar-fixed-top"><div class="navbar-inner"><div id="topSection" class="container"><span class="brand"></span><ul class="nav topLinks"><li id="ace_site"><a href="../index.html">Ace</a></li><li id="ace_api" class="active"><a href="index.html">Ace API Reference</a></li></ul><form id="searchbox" action="" class="navbar-search pull-right"> <input name="query" type="text" placeholder="Search the API" title="Search across all the documentation" class="search-query span3"></form></div></div></div><div id="nonFooter"><div id="wrapper"><div class="content"><div class="row centerpiece"><div id="sidebarContainer" class="span3"><div id="sidebar"><div id="well"><h3>Ace Reference</h3><div class="swirl_divider"> </div><ul class="menu"><li><div class="menu-item"><a href="ace.html" class="menuLink namespace">Ace</a></div></li><li><div class="menu-item"><a href="anchor.html" class="menuLink namespace">Anchor</a></div></li><li><div class="menu-item"><a href="background_tokenizer.html" class="menuLink namespace">BackgroundTokenizer </a></div></li><li><div class="menu-item"><a href="document.html" class="menuLink namespace">Document </a></div></li><li><div class="menu-item"><a href="edit_session.html" class="menuLink namespace">EditSession </a></div></li><li><div class="menu-item"><a href="editor.html" class="menuLink namespace">Editor</a></div></li><li><div class="menu-item"><a href="range.html" class="menuLink namespace">Range</a></div></li><li><div class="menu-item"><a href="scrollbar.html" class="menuLink namespace">Scrollbar</a></div></li><li><div class="menu-item"><a href="search.html" class="menuLink namespace">Search </a></div></li><li><div class="menu-item"><a href="selection.html" class="menuLink namespace">Selection </a></div></li><li><div class="menu-item"><a href="token_iterator.html" class="menuLink namespace">TokenIterator</a></div></li><li><div class="menu-item"><a href="tokenizer.html" class="menuLink namespace">Tokenizer</a></div></li><li><div class="menu-item"><a href="undomanager.html" class="menuLink namespace">UndoManager</a></div></li><li><div class="menu-item"><a href="virtual_renderer.html" class="menuLink namespace">VirtualRenderer</a></div></li></ul></div></div></div><div id="mainContent" class="span9"><div id="documentation"><div class="classContent"><div class="membersBackground"></div><div class=" members pos0"><div class=" membersContent pos0"><h1 class="memberHeader"><span class="name">Ace<span class="editInC9"><a href='http://c9.io/open/git/?url=git%3A%2F%2Fgithub.com%2Fajaxorg%2Face.git' title='Edit in Cloud9 IDE'>[edit]</a></span></span></h1><ul data-tabs="tabs" class="nav tabs pos0"><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (1)</span><b class="caret"></b></a><ul class="dropdown-menu"><li data-id="Ace.edit" class="memberLink"><a href="#Ace.edit" class="" title="Ace.edit (class method)" data-id="Ace.edit">edit</a></li></ul></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li></ul></div></div><article id="Ace" data-title="Ace (class)" class="article"><div class="section description"><div class="memberContent"><p>The main class required to set up an Ace instance in the browser.</p>
|
||||
</div></div></article><h3 class="sectionHeader">Methods</h3><article id="Ace.edit" data-title="Ace.edit (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="Ace.edit" class="member-name methodClicker"><span class="sigClassName">Ace.</span><span class="sigMemberName">edit</span></span>(<span class="sigArgList"><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="argument methodClicker" title="String" data-id="String">String</a> | <a href="https://developer.mozilla.org/en/DOM/element" class="argument methodClicker" title="DOMElement" data-id="DOMElement">DOMElement</a> el</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="editor.html#Editor" class="returnType " title="Editor (class)" data-id="Editor">Editor</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Ace.edit" class="ellipsis_description"><p>This method embeds the Ace editor into the DOM, at the element provided by <code>el</code>.</p>
|
||||
</div><div id="short_Ace.edit" class="short_description hiddenSpan"><p>This method embeds the Ace editor into the DOM, at the element provided by <code>el</code>.</p>
|
||||
</div><h3 id="Ace.edit" class="methodToggle methodClicker inactive"> </h3><div class="description"><h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">el</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="" title="String" data-id="String">String</a> | <a href="https://developer.mozilla.org/en/DOM/element" class="" title="DOMElement" data-id="DOMElement">DOMElement</a></td><td class="argDescription ">Required. Either the id of an element, or the element itself</td></tr></table></div></div></div></div></article></div></div><div id="disqus_thread"></div></div></div></div></div><div class="push"></div></div><div id="footer"><div class="footerInner"><div class="footer-text pull-right"> <p><a href="http://www.c9.io">About Cloud9</a> | Ace & Cloud9 IDE are © <a href="http://ajax.org">Ajax.org</a> 2012</p></div></div></div><!-- scripts concatenated and minified via ant build script--><script defer src="./resources/javascripts/plugins.js"></script>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
13
api/command_manager.html
Normal file
13
api/command_manager.html
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
12
api/renderloop.html
Normal file
12
api/renderloop.html
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
The API doc build takes a look a source Javascript files in the _lib_ directory, and turns it into HTML output in the _api_ directory. It uses [Panino](https://github.com/gjtorikian/panino-docs) to perform the conversion.
|
||||
|
||||
For any questions, please see that repo.
|
||||
For any questions on the build system, please see that repo.
|
||||
|
||||
# Building
|
||||
|
||||
|
|
@ -15,14 +15,3 @@ In this directory, just run:
|
|||
npm install
|
||||
node build.js
|
||||
|
||||
# Build File
|
||||
|
||||
Here's a breakdown of what the arguments in _build.js_ are doing:
|
||||
|
||||
`--path=srcPath`: The location of the Ace source
|
||||
`-o=../api/`: The location of the output
|
||||
`-a=./additionalObjs.json`: A list of URLs to use for "missing objects" that the documentation requires
|
||||
`-i=index.md`: The location of the Ace index/landing page
|
||||
`-t=Ace API`: The title of the documentation
|
||||
`--skin=./resources/ace/`: The location of all the templates and design
|
||||
`-s`: Choose to split each class into its own file
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
"name": "ace-api",
|
||||
"version": "0.1.0",
|
||||
"dependencies": {
|
||||
"panino" : ">=2.0.1"
|
||||
"panino" : ">=2.0.1",
|
||||
"asset-smasher": "0.2.0"
|
||||
}
|
||||
}
|
||||
|
|
@ -18,7 +18,7 @@ mixin head
|
|||
-if (isIndex)
|
||||
title #{title}
|
||||
-else
|
||||
title #{title} - #{fileName}
|
||||
title #{classId} - #{title}
|
||||
|
||||
meta(name="generator", content="c9-doc-build")
|
||||
meta(name="description", content="Ace API documentation for the online code editor.")
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue