This repository has been archived by the owner on Nov 22, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
10 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
this is empty rn because I'm trying to find a way to have it both on the website and the repo without copying stuff back and forth (the website uses markdown as well) | ||
|
||
https://www.scrollmeister.com/docs.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,14 @@ | ||
# What is Scrollmeister? | ||
|
||
Scrollmeister is an open-source JavaScript framework to declaratively build scrolling experiences. Using custom elements (`<scroll-meister>`, `<element-meister>` and `<shadow-meister>`) you can create complex interactive scrolling pages _without a single line of code_. All you need is an HTML editor and you're good to go, you can even render the pages on the server. Scrollmeister comes with it's own layout engine called Guides Layout. It was built from the ground up with scrolling interactions in mind. This makes it ridiculously performant (on both desktop and touch devices). | ||
|
||
# What is it _not_? | ||
|
||
Scrollmeister solves a particular problem really well, but it is important to understand when _not_ to use Scrollmeister. | ||
|
||
* Scrollmeister is not a drop-in library that you can use with your existing website. To achieve its flexibility and performance Scrollmeister needs full control over the elements of a web page. However, Scrollmeister does not lock you into its system in the sense that you can do whatever you want _inside_ of a `<element-meister>` Element. | ||
* If you're creating a "regular" public facing website then Scrollmeister might not be the right choice. If all you need is a parallax header image then just use a jQuery plugin. Scrollmeister is meant for complex scrolling interactions spanning multiple elements, e.g. Stories or Presentations. | ||
* If you're creating a "regular" public facing website then Scrollmeister might not be the right choice. If all you need is a parallax header image then just use a jQuery plugin. Scrollmeister is meant for complex scrolling interactions spanning multiple elements, e.g. stories or presentations. | ||
|
||
# Docs | ||
|
||
Check out the [website](https://www.scrollmeister.com/) and [demos](https://www.scrollmeister.com/demos/) for now, this is highly WIP. |