diff --git a/README.md b/README.md index b1d094ab..54e89821 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -#THIS REPO IS DEPRECATED -##Mixed Mode can be found at [https://github.com/famous/engine](https://github.com/famous/engine) +# THIS REPO IS DEPRECATED +## Mixed Mode can be found at [https://github.com/famous/engine](https://github.com/famous/engine) If you are looking for the old website with the support material for this version of famous please visit [http://deprecated.famous.org](http://deprecated.famous.org) diff --git a/guides/layout.md b/guides/layout.md index 3a07ce45..6ddc3105 100644 --- a/guides/layout.md +++ b/guides/layout.md @@ -291,7 +291,7 @@ properties can animate over time. This can be done in one of two methods: - [push-based](#push) - [pull-based](#pull) -####Push-based animations +#### Push-based animations The `StateModifier` class found in Famous/modifiers/StateModifier.js is a push-based implementation. Here, `StateModifier` has the methods @@ -326,7 +326,7 @@ stateModifier.setOpacity( ); ``` -####Pull-based animations +#### Pull-based animations The `Modifier` class found in Famous/core/Modifier.js is a pull-based implementation. The `Modifier` itself doesn't keep any state (like what the diff --git a/guides/migrating-0.2-to-0.3.md b/guides/migrating-0.2-to-0.3.md index 8f9bda31..f6182d5b 100644 --- a/guides/migrating-0.2-to-0.3.md +++ b/guides/migrating-0.2-to-0.3.md @@ -89,7 +89,7 @@ The `initial-scale=1` setting will ensure that the content is displayed correctl First, let's look at the breaking changes in the v0.3 release of Famo.us: -###src folder +### src folder All src code is now found in a src/ folder. This will cause issues with any pathing you are currently relying on. Please see the above sections that describe how to properly update your tooling stack accordingly. ### Align & origin diff --git a/guides/render-tree.md b/guides/render-tree.md index b2d2cc32..4c10bb96 100644 --- a/guides/render-tree.md +++ b/guides/render-tree.md @@ -26,7 +26,7 @@ the expectations every web developer has of the DOM, but in a way that doesn't c performance. The Render Tree is our solution to relative positioning and semantic structure. In other documentation we'll go into events and animation. -#Overview +# Overview - [Creating the Tree](#creation) - [Extending the Tree](#extension) @@ -39,7 +39,7 @@ semantic structure. In other documentation we'll go into events and animation. - [The Big Picture](#review) -##Creating the Tree +## Creating the Tree A tree's starting point is called its root. In HTML, this root is the `` tag. @@ -52,7 +52,7 @@ class `famous-container` (we can also pass in a pre-existing DOM element). │ ``` -##Extending the Tree +## Extending the Tree So far we have a pretty boring app. A Context has no visual representation, @@ -68,7 +68,7 @@ corresponds to a `
` in HTML. This `
` will be nested inside of the surface context.add(surface); ``` -##Types of Nodes +## Types of Nodes A tree is made up of nodes. In HTML, these nodes are tags like `
` or @@ -77,7 +77,7 @@ Above, we saw how to add one type of renderable, a Surface, to the Render Tree. Below, we will examine other kinds of nodes that make up a typical Render Tree. -##Renderables +## Renderables Renderables are nodes that get drawn to the screen. We have already been @@ -108,7 +108,7 @@ complex composited renderables. These are called Views and will be discussed [below](#views). -##Modifiers +## Modifiers A Modifier is another type of Famo.us node that is capable of modifying @@ -140,7 +140,7 @@ then the surface will be at `[100px, 200px]` from the top left of the Context. Modifiers also have more complicated support for layout, like auto-centering and sizing, but this will be discussed in a different tutorial. -##Chaining Nodes +## Chaining Nodes Modifiers affect the render tree beneath them. But that means Modifiers can @@ -158,7 +158,7 @@ separating state easy to do. One modifier can handle opacity, another, rotation. surface ``` -##Branching Nodes +## Branching Nodes So far our Render Trees have been linear: one node sequentially following another. @@ -191,7 +191,7 @@ Here, `surface1` and `surface2` are both relative to `modifier1`, and (assuming these modifiers are for translating nodes). -##Views +## Views So far we've seen that you can add Modifiers and Surfaces to the Render Tree. @@ -262,7 +262,7 @@ manageable. And unlike DOM, there is no performance degradation incurred from nesting structure; everything is flattened by the time it gets to the DOM. -##The Big Picture +## The Big Picture > It's modifiers all the way down - *Anon*