jyapayne/ace
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ace/doc
History
Garen Torikian 79886c3e07 First dump of doc stuff
2012-02-02 17:00:18 -08:00
..
resources First dump of doc stuff 2012-02-02 17:00:18 -08:00
site move documentation around 2011-08-04 15:53:53 +02:00
wiki@d2a65d0add wiki 2011-11-28 16:20:35 +01:00
.gitignore First dump of doc stuff 2012-02-02 17:00:18 -08:00
build.js First dump of doc stuff 2012-02-02 17:00:18 -08:00
Contributor_License_Agreement-v2.pdf add CLAs to the doc directory 2011-04-27 09:52:29 +02:00
Corporate_Contributor_License_Agreement-v2.pdf add CLAs to the doc directory 2011-04-27 09:52:29 +02:00
Editor.mm add some ideas 2011-01-17 13:03:11 +01:00
package.json First dump of doc stuff 2012-02-02 17:00:18 -08:00
README.md First dump of doc stuff 2012-02-02 17:00:18 -08:00

README.md

Introduction

The beginnings of an API documentation set for Ace.

This documentation can't be build without C9's version of 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 theme. A real style is pending. Also there are a lot of TODO items so you should really be more concerned about that.