Giter VIP home page Giter VIP logo

treesaver's Introduction

Treesaver

Treesaver is JavaScript framework for creating magazine-style layouts using standards-compliant HTML and CSS.

Getting Started / Documentation

The 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.

Building Treesaver

Use the instructions below if you wish to build Treesaver from scratch. Most people are better off downloading a pre-built version.

Dependencies

  • Paver: For running build script. Requires Python.
  • Closure Linter: 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.

  • paver: Create dependency script for testing
  • paver compile: Compile JavaScript files for production. Can be used with one or more compilation flags:
    • --modules: Compile into modules for async loading (compiles into two separate files)
    • --debug: Use debug-friendly minification
    • --ios: Compile version for use within an IOS UIWebView
    • --noie: Compile without IE support
    • --nolegacy: Compile without support for legacy browsers (IE7, mostly)
  • paver debug: Concatenate files for use when debugging (preserves comments, formatting, etc). Supports the following compilation flags:
    • --ios: Compile version for use within an IOS UIWebView
    • --modules: Compile into modules for async loading (compiles into two separate files)
  • paver clean: remove build artifacts
  • paver lint: Check style with lint
  • paver fix_lint: Automatically fix lint errors

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 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.

Contributors

treesaver's People

Contributors

fortes avatar bramstein avatar

Stargazers

Anselmo Silva avatar

Watchers

Anselmo Silva avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.