First dump of doc stuff
3
doc/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
.DS_Store
|
||||
out/
|
||||
node_modules/
|
||||
15
doc/README.md
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# Introduction
|
||||
|
||||
The beginnings of an API documentation set for Ace.
|
||||
|
||||
This documentation can't be build without [C9's version of ndoc](https://github.com/c9/ndoc), so you should clone that repo somewhere, too. Note to self: since there's a billion people following this project, should I just make this ndoc a submodule, similair to NodeManual? I'd rather not.
|
||||
|
||||
# Building
|
||||
|
||||
In this directory, just run
|
||||
|
||||
node build.js [path_to_ndoc]
|
||||
|
||||
`[path_to_ndoc]` is a required argument, indicating the location of your ndoc install, relative to the `build.js` file. By default, this will point to `./build/ndoc/bin/ndoc`.
|
||||
|
||||
Right now, yes, we're using the [NodeManual.org](http://www.nodemanual.org) theme. A real style is pending. Also there are a lot of *TODO* items so you should really be more concerned about that.
|
||||
15
doc/build.js
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
require("colors");
|
||||
|
||||
var argv = require("optimist").argv,
|
||||
ndoc = require(argv._[0] || "./build/ndoc/bin/ndoc");
|
||||
|
||||
console.log("GENERATING DOCUMENTATION".green);
|
||||
|
||||
var srcPath = process.cwd() + "/../lib/ace";
|
||||
|
||||
ndoc.main(["--path=" + srcPath, "-o", "./out/", "-t", "ACE API", "--skin", "./resources/ace/skins"], function(err) {
|
||||
if (err) {
|
||||
console.error(err);
|
||||
process.exit(-1);
|
||||
}
|
||||
});
|
||||
21
doc/package.json
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
{
|
||||
"name": "ace_docs",
|
||||
"version": "0.0.1",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git://github.com/ajaxorg/ace.git"
|
||||
},
|
||||
"engines": {
|
||||
"node": "~0.6.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"colors": "~0.6.0",
|
||||
"optimist": "~0.3.1",
|
||||
"nomnom": "~1.5.1",
|
||||
"jade": "~0.20.0",
|
||||
"marked": "~0.1.5",
|
||||
"fs-tools": "~0.1.0",
|
||||
"markdown_conrefs": "1.0.2"
|
||||
},
|
||||
"devDependencies": {}
|
||||
}
|
||||
2471
doc/resources/ace/skins/skeleton/csses/bootstrap.css
vendored
Normal file
52
doc/resources/ace/skins/skeleton/csses/prettify.css
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
/* Pretty printing styles. Used with prettify.js. */
|
||||
|
||||
/* SPAN elements with the classes below are added by prettyprint. */
|
||||
.pln { color: #000 } /* plain text */
|
||||
|
||||
@media screen {
|
||||
.str { color: #2e6a40 } /* string content */
|
||||
.kwd { color: #214afc } /* a keyword */
|
||||
.com { color: #4c886b } /* a comment */
|
||||
.typ { color: #1130ad } /* a type name */
|
||||
.lit { color: #1130ad } /* a literal value */
|
||||
/* punctuation, lisp open bracket, lisp close bracket */
|
||||
.pun, .opn, .clo { color: #2d0603 }
|
||||
.tag { color: #008 } /* a markup tag name */
|
||||
.atn { color: #606 } /* a markup attribute name */
|
||||
.atv { color: #080 } /* a markup attribute value */
|
||||
.dec, .var { color: #606 } /* a declaration; a variable name */
|
||||
.fun { color: #1130ad } /* a function name */
|
||||
}
|
||||
|
||||
/* Use higher contrast and text-weight for printable form. */
|
||||
@media print, projection {
|
||||
.str { color: #060 }
|
||||
.kwd { color: #006; font-weight: bold }
|
||||
.com { color: #600; font-style: italic }
|
||||
.typ { color: #404; font-weight: bold }
|
||||
.lit { color: #044 }
|
||||
.pun, .opn, .clo { color: #440 }
|
||||
.tag { color: #006; font-weight: bold }
|
||||
.atn { color: #404 }
|
||||
.atv { color: #060 }
|
||||
}
|
||||
|
||||
/* Put a border around prettyprinted code snippets. */
|
||||
/*pre.prettyprint { padding: 2px; }*/
|
||||
|
||||
/* Specify class=linenums on a pre to get line numbering */
|
||||
ol.linenums { margin-top: 0; margin-bottom: 0 } /* IE indents via margin-left */`
|
||||
li.L0,
|
||||
li.L1,
|
||||
li.L2,
|
||||
li.L3,
|
||||
li.L5,
|
||||
li.L6,
|
||||
li.L7,
|
||||
li.L8 { list-style-type: none }
|
||||
/* Alternate shading for lines */
|
||||
li.L1,
|
||||
li.L3,
|
||||
li.L5,
|
||||
li.L7,
|
||||
li.L9 { background: #eee }
|
||||
1031
doc/resources/ace/skins/skeleton/csses/refguide_overrides.css
Normal file
BIN
doc/resources/ace/skins/skeleton/images/arrow-footer.png
Normal file
|
After Width: | Height: | Size: 2 KiB |
BIN
doc/resources/ace/skins/skeleton/images/c9-log-footer.png
Normal file
|
After Width: | Height: | Size: 6.7 KiB |
BIN
doc/resources/ace/skins/skeleton/images/c9-sponsor.png
Normal file
|
After Width: | Height: | Size: 12 KiB |
BIN
doc/resources/ace/skins/skeleton/images/cloud9-logo.png
Normal file
|
After Width: | Height: | Size: 14 KiB |
BIN
doc/resources/ace/skins/skeleton/images/content-bg.png
Normal file
|
After Width: | Height: | Size: 3.2 KiB |
BIN
doc/resources/ace/skins/skeleton/images/content-top-bg.png
Normal file
|
After Width: | Height: | Size: 3.4 KiB |
BIN
doc/resources/ace/skins/skeleton/images/content-top.png
Normal file
|
After Width: | Height: | Size: 3.1 KiB |
BIN
doc/resources/ace/skins/skeleton/images/footer-bg.png
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
doc/resources/ace/skins/skeleton/images/main-bg.png
Normal file
|
After Width: | Height: | Size: 6.7 KiB |
BIN
doc/resources/ace/skins/skeleton/images/member-sprites.png
Normal file
|
After Width: | Height: | Size: 3.4 KiB |
BIN
doc/resources/ace/skins/skeleton/images/menu_disc.png
Normal file
|
After Width: | Height: | Size: 556 B |
BIN
doc/resources/ace/skins/skeleton/images/method-bg.png
Normal file
|
After Width: | Height: | Size: 6.8 KiB |
|
After Width: | Height: | Size: 3.8 KiB |