https://github.com/Treesaver/treesaver

JavaScript library for creating column and page-based layouts
https://github.com/Treesaver/treesaver

Last synced: about 1 month ago
JSON representation

JavaScript library for creating column and page-based layouts

• Host: GitHub
• URL: https://github.com/Treesaver/treesaver
• Owner: Treesaver
• License: gpl-2.0
• Created: 2010-09-10T23:38:28.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2015-11-27T22:05:34.000Z (about 9 years ago)
• Last Synced: 2024-10-30T04:50:09.362Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 24.9 MB
• Stars: 1,061
• Watchers: 49
• Forks: 107
• Open Issues: 103
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: MIT-LICENSE.txt

Awesome Lists containing this project

• awesome-starred - Treesaver/treesaver - JavaScript library for creating column and page-based layouts (others)

README

        
# Treesaver

[Treesaver](http://www.treesaverjs.com) is JavaScript framework for creating magazine-style layouts using standards-compliant HTML and CSS.

## Getting Started / Documentation

The [Treesaver wiki](http://github.com/treesaver/treesaver/wiki) is the best source of documentation and reference. Note that the documentation is still a work in progress.

## Support/Questions

Use the [Treesaver.js Mailing List](http://groups.google.com/group/treesaverjs).

## Building Treesaver

Use the instructions below if you wish to build Treesaver from scratch. *Most people are better off [downloading a pre-built version](http://github.com/treesaver/treesaver/downloads)*.

### Dependencies

* [CoffeeScript](http://jashkenas.github.com/coffee-script/): For running build script.

* [Python](http://www.python.org/) & [Java](http://www.java.com/en/download/): For using Google's compiler tools.

* [Closure Linter](http://code.google.com/closure/utilities/docs/linter_howto.html): Check and fix coding style. (optional)

### Setup Instructions

1. Make sure to install all the dependencies

2. Clone a copy of the Treesaver repo by running: `git clone git://github.com/treesaver/treesaver.git`

### Commands

Note that these commands *must* be run from the root directory of the repository. You can type `cake` to view available commands.

* `cake deps`: Create dependency script for testing

* `cake compile`: Compile JavaScript files for production. Can be used with one or more compilation flags:

  * `cake --debug compile`: Use debug-friendly minification

  * `cake --ios compile`: Compile version for use within an IOS `UIWebView`

* `cake debug`: Concatenate files for use when debugging (preserves comments, formatting, etc). Supports the following compilation flags:

  * `cake --ios debug`: Compile version for use within an IOS `UIWebView`

* `cake lint`: Check style with lint

* `cake fix_lint`: Automatically fix lint errors

* `cake clean`: remove build artifacts

## License

Dual-licensed under MIT and GPLv2

## Contributing

### Coding Style

Yes, the code looks verbose and kind of like Java. That is because it follows the Google Closure style. This is in order to get better compression via the Closure Compiler. [UglifyJS](http://github.com/mishoo/UglifyJS) shows a lot of potential, and merits investigation.

Although Google Closure style and compiler are used, note that Treesaver does *not* use the [Closure Library](http://code.google.com/closure/library/) (other than a few functions in `base.js` which are used for dependency management and are not present in production).

### Contributors

* [Filipe Fortes](http://www.fortes.com/) [@fortes](http://twitter.com/fortes)

* [Bram Stein](http://www.bramstein.com/) [@bram_stein](http://twitter.com/bram_stein)