Skip to content

Commit

Permalink
☕ CHORE: update docs page (#1486)
Browse files Browse the repository at this point in the history
  • Loading branch information
warengonzaga committed Mar 1, 2022
1 parent ed1e0fd commit 40b9139
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -882,7 +882,7 @@ <h2 class="docs-mainTitle">


<section class="docSection-usage" id="usage">
<h2>Installation and usage</h2>
<h2>Installation and Usage</h2>
<h3>Installing</h3>
<p>Install with npm:</p>
<pre><code class="language-shell">$ npm install animate.css --save
Expand Down Expand Up @@ -949,7 +949,7 @@ <h4>CSS Custom Properties (CSS Variables)</h4>


<section class="docSection-utilities" id="utilities">
<h2>Utility classes</h2>
<h2>Utility Classes</h2>
<p>Animate.css comes packed with a few utility classes to simplify its use.</p>
<h3>Delay classes</h3>
<p>You can add delays directly on the element's class attribute, just like this:</p>
Expand Down Expand Up @@ -1080,7 +1080,7 @@ <h3>Repeating classes</h3>


<section class="docSection-best-practices" id="best-practices">
<h2>Best practices</h2>
<h2>Best Practices</h2>
<p>Animations can greatly improve an interface's UX, but it's important to follow some guidelines to not overdo it and deteriorate the user experience on your web-things. Following the following rules should provide a good start.</p>
<h3>Meaningful animations</h3>
<p>You should avoid animating an element just for the sake of it. Keep in mind that animations should make an intention clear. Animations like attention seekers (bounce, flash, pulse, etc) should be used to bring the user's attention to something special in your interface and not only as a way to bring &quot;flashiness&quot; to it.</p>
Expand Down Expand Up @@ -1172,7 +1172,7 @@ <h2>Usage with Javascript</h2>


<section class="docSection-migration" id="migration">
<h2>Migration from v3.x and under</h2>
<h2>Migration from v3.x and Under</h2>
<p>Animate.css v4 brought some improvements, improved animations, and new animations, which makes it worth upgrading. However, it also comes with a breaking change: we have added a prefix for all of the Animate.css classes - defaulting to <code>animate__</code> - so a direct migration is impossible.</p>
<p>But fear not! Although the default build, <code>animate.min.css</code>, brings the <code>animate__</code> prefix we also provide the <code>animate.compat.css</code> file which brings no prefix at all, like the previous versions (3.x and under).</p>
<p>If you're using a bundler, update your import:</p>
Expand Down Expand Up @@ -1260,7 +1260,7 @@ <h2>Accessibility</h2>


<section class="docSection-contributors" id="contributors">
<h2>Core team</h2>
<h2>Core Team</h2>
<table>
<thead>
<tr>
Expand All @@ -1273,7 +1273,7 @@ <h2>Core team</h2>
<tr>
<td><a href="https://github.com/daneden">Daniel Eden</a></td>
<td><a href="https://github.com/eltonmesquita">Elton Mesquita</a></td>
<td><a href="https://github.com/WarenGonzaga">Waren Gonzaga</a></td>
<td><a href="https://github.com/warengonzaga">Waren Gonzaga</a></td>
</tr>
<tr>
<td>Animate.css Creator</td>
Expand Down
2 changes: 1 addition & 1 deletion docsSource/sections/01-usage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Installation and usage
## Installation and Usage

### Installing

Expand Down
2 changes: 1 addition & 1 deletion docsSource/sections/02-utilities.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Utility classes
## Utility Classes

Animate.css comes packed with a few utility classes to simplify its use.

Expand Down
2 changes: 1 addition & 1 deletion docsSource/sections/03-best-practices.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Best practices
## Best Practices

Animations can greatly improve an interface's UX, but it's important to follow some guidelines to not overdo it and deteriorate the user experience on your web-things. Following the following rules should provide a good start.

Expand Down
2 changes: 1 addition & 1 deletion docsSource/sections/06-migration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Migration from v3.x and under
## Migration from v3.x and Under

Animate.css v4 brought some improvements, improved animations, and new animations, which makes it worth upgrading. However, it also comes with a breaking change: we have added a prefix for all of the Animate.css classes - defaulting to `animate__` - so a direct migration is impossible.

Expand Down
4 changes: 2 additions & 2 deletions docsSource/sections/09-contributors.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Core team
## Core Team

| ![](https://avatars2.githubusercontent.com/u/439365?s=460&u=512b4cc5324938ae40bbb8f3b7769d335953cd3a&v=4) | ![](https://avatars2.githubusercontent.com/u/5007208?s=460&u=418401ee605824272e5dcb955fd64ea24546a857&v=4) | ![](https://avatars1.githubusercontent.com/u/15052701?s=460&u=9e58364978379536d3f26c4ce5cae1a2a449a0e4&v=4) |
| --- | --- | --- |
| [Daniel Eden](https://github.com/daneden) | [Elton Mesquita](https://github.com/eltonmesquita) | [Waren Gonzaga](https://github.com/WarenGonzaga) |
| [Daniel Eden](https://github.com/daneden) | [Elton Mesquita](https://github.com/eltonmesquita) | [Waren Gonzaga](https://github.com/warengonzaga) |
| Animate.css Creator | Maintainer | Core Contributor |

0 comments on commit 40b9139

Please sign in to comment.