Skip to content

Commit

Permalink
working on docs
Browse files Browse the repository at this point in the history
  • Loading branch information
justinbmeyer committed Aug 30, 2016
1 parent c6ed55d commit 4da3c1e
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 36 deletions.
2 changes: 2 additions & 0 deletions demos/can-component/paginate.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,8 @@

fixture("/websites/{id}", websiteStore);

fixture.delay = 2000;

var Paginate = DefineMap.extend({
count: {
value: Infinity,
Expand Down
27 changes: 17 additions & 10 deletions docs/can-canjs/canjs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
@page canjs CanJS
@dest ../index
@description A constantly evolving and improving set of client side JavaScript architectural libraries.
@description CanJS is an evolving and improving set of client side
JavaScript architectural libraries that balances
innovation and stability.

CanJS targets experienced developers building complex applications
with long futures ahead of them. Read more about [Why CanJS].

<img src="docs/can-canjs/tortoise.png"/>

@body

Expand All @@ -13,31 +20,31 @@ _The best, most hardened and generally useful libraries in CanJS._
- **[can-construct]** <small>1.3.3</small> Extensible constructors
- `npm install can-construct --save`
- <a class="github-button" href="https://github.com/canjs/can-construct" data-count-href="/canjs/can-construct/stargazers" data-count-api="/repos/canjs/can-construct#stargazers_count">Star</a>
- **[can-define]** <small>1.3.3</small> Observables
- **[can-define]** <small>1.3.3</small> Observables
- `npm install can-define --save`
- <a class="github-button" href="https://github.com/canjs/can-define" data-count-href="/canjs/can-define/stargazers" data-count-api="/repos/canjs/can-define#stargazers_count">Star</a>
- **[can-compute]** <small>1.3.3</small> Observables
- **[can-compute]** <small>1.3.3</small> Observables
- `npm install can-compute --save`
- <a class="github-button" href="https://github.com/canjs/can-compute" data-count-href="/canjs/can-compute/stargazers" data-count-api="/repos/canjs/can-compute#stargazers_count">Star</a>
- **[can-connect]** <small>1.3.3</small> Data connection
- `npm install can-connect --save`
- <a class="github-button" href="https://github.com/canjs/can-connect" data-count-href="/canjs/can-connect/stargazers" data-count-api="/repos/canjs/can-connect#stargazers_count">Star</a>
- **[can-set]** <small>1.3.3</small> Service modeling
- **[can-set]** <small>1.3.3</small> Service modeling
- `npm install can-set --save`
- <a class="github-button" href="https://github.com/canjs/can-set" data-count-href="/canjs/can-set/stargazers" data-count-api="/repos/canjs/can-set#stargazers_count">Star</a>
- **[can-route]** <small>1.3.3</small> Routing
- **[can-route]** <small>1.3.3</small> Routing
- `npm install can-route --save`
- <a class="github-button" href="https://github.com/canjs/can-route" data-count-href="/canjs/can-route/stargazers" data-count-api="/repos/canjs/can-route#stargazers_count">Star</a>
- **[can-route-pushstate]** <small>1.3.3</small> Pushy routing
- **[can-route-pushstate]** <small>1.3.3</small> Pushy routing
- `npm install can-route-pushstate --save`
- <a class="github-button" href="https://github.com/canjs/can-route-pushstate" data-count-href="/canjs/can-route-pushstate/stargazers" data-count-api="/repos/canjs/can-route-pushstate#stargazers_count">Star</a>
- **[can-stache]** <small>1.3.3</small> Live binding templates
- **[can-stache]** <small>1.3.3</small> Live binding templates
- `npm install can-stache --save`
- <a class="github-button" href="https://github.com/canjs/can-stache" data-count-href="/canjs/can-stache/stargazers" data-count-api="/repos/canjs/can-stache#stargazers_count">Star</a>
- **[can-component]** <small>1.3.3</small> Custom elements
- **[can-component]** <small>1.3.3</small> Custom elements
- `npm install can-component --save`
- <a class="github-button" href="https://github.com/canjs/can-component" data-count-href="/canjs/can-component/stargazers" data-count-api="/repos/canjs/can-component#stargazers_count">Star</a>
- **[can-stache-bindings]** <small>1.3.3</small> View bindings
- **[can-stache-bindings]** <small>1.3.3</small> View bindings
- `npm install can-stache-bindings --save`
- <a class="github-button" href="https://github.com/canjs/can-stache-bindings" data-count-href="/canjs/can-stache-bindings/stargazers" data-count-api="/repos/canjs/can-stache-bindings#stargazers_count">Star</a>

Expand Down Expand Up @@ -89,4 +96,4 @@ still accept patches._

Before you make an issue, please read our [Contributing] guide.

You can find the core team in [gitter chat](https://gitter.im/canjs/canjs).
You can find the core team in [gitter chat](https://gitter.im/canjs/canjs).
Binary file added docs/can-canjs/tortoise.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
59 changes: 33 additions & 26 deletions docs/can-guides/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,47 @@

@body

CanJS is designed to be a very well-rounded JavaScript framework, useful to almost any client-side JavaScript
team.
CanJS is an evolving and improving set of client side
JavaScript architectural libraries that balances
innovation and stability.

It provides a wealth of JavaScript utilities that combine to make testable and repeatable Model-View-ViewModel
applications with very little code.
CanJS targets experienced developers building complex applications
with long futures ahead of them.

CanJS provides the default MV\* libraries to the [DoneJS](http://donejs.com) framework. Checkout DoneJS's [quick
start guide](http://donejs.com/Guide.html) for an example of using CanJS to build a server-side rendered, real-time
chat app that works as an Android, iOS, and Desktop app.
If this is you, checkout the quick start guide
where you build TodoMVC in about an hour.

<h2 id="Flexible">Flexible</h2>
If you're not sure if this is you, the importance of
CanJS's goals, or how CanJS accomplishes these goals, please read on.

CanJS is __flexible__. Unlike other frameworks, it's designed to work in almost any situation.
You can readily use third party plugins or
modify the DOM with jQuery directly.
CanJS supports all browsers.

<h2 id="Powerful">Powerful</h2>
## CanJS's Goals

CanJS is __powerful__. Create [custom elements](../docs/can.Component.html) with
[one and two-way bindings](/docs/can.view.bindings.html).
Easily [define](../docs/can.Map.prototype.define.html) the behavior of
observable objects and their derived values. Avoid memory
leaks with smart model stores and smart event binding.
The goal of CanJS can be summarized as follows:

<h2 id="Fast">Fast</h2>
> You shouldn't have to rewrite your application to
> keep pace with technology.
CanJS is __fast__. It is only about 20k. Its live-binding updates only what needs to be updated without requiring a
"diff".
Technology changes quickly. The popular frameworks and tools
used today will likely not be the same as those used two
years from now. Even those that might still be around will
probably not be easy to upgrade to.

But developers need stable platforms to develop from.

<h2 id="Friendly">Friendly</h2>
CanJS attempts to strike a balance between these two
conflicting problems by:

CanJS is __friendly__. Our [fulltime](http://donejs.com/About.html#section=section_Fulltimeteam) and
[core](http://donejs.com/About.html#section=section_Coreteam) team are extremely active on
[gitter chat](https://gitter.im/canjs/canjs) and on the [forums](http://forums.donejs.com/c/canjs) and
always wanting to help.
- Providing high quality individually useful and stand-alone libraries.
- Adopting to new ideas/technology and then integrating as new libraries
or features of existing ones.

The experience of using CanJS should be relatively easy at the start,
but extremely rewarding one over time.

Bug fixes should be resolved quickly.

New features and libraries should be added that keeps pace with
innovation.

Breaking changes should be simple to migrate.

0 comments on commit 4da3c1e

Please sign in to comment.