Mibew/CanteenHTML5
1
0
Fork 0
mirror of https://github.com/Mibew/CanteenHTML5.git synced 2024-11-15 00:34:11 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Ignore the docs folder, updated readme

Browse Source
This commit is contained in:
mattmoore 2013-10-14 15:40:07 -04:00
parent d6d68a9cb8
commit 0de641c3cc
2 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
/docs/*

12
README.md
View File

@ -2,6 +2,8 @@
Create dynamic, well-formatted HTML5 markup with a simple an intuitive PHP API. This is a fork/rewrite of the [Gagawa](https://code.google.com/p/gagawa/) project. CanteenHTML5 is a concise, flexible and easy to remember API which makes it possible to create simple markup (such as a link) or more complex structures (such a table, document or nested list). All tags and attribute names are validated against the current HTML5 specification.
For documentation of the codebase, please see [Canteen HTML5 docs](http://canteen.github.io/CanteenHTML5/);
##Requirements
@ -224,8 +226,16 @@ $table = new Table(
);
```
###Rebuild Documentation
This library is auto-documented using [YUIDoc](http://yui.github.io/yuidoc/). To install YUIDoc, run `sudo npm install yuidocjs`. Also, this requires the project [CanteenTheme](http://github.com/Canteen/CanteenTheme) be checked-out along-side this repository. To rebuild the docs, run the ant task from the command-line.
```bash
ant docs
```
##License##
Copyright (c) 2013 Matt Karl and [CloudKid, LLC](http://cloudkid.com)
Copyright (c) 2013 [Matt Karl](http://github.com/bigtimebuddy)
Released under the MIT License.