Skip to content

Commit 691a54b

Browse files
rommguyrommguy
committedApr 8, 2016
Create gh-pages branch via GitHub
·
v4.2.3v1.3.1
1 parent ff6d6e1 commit 691a54b

File tree

3 files changed

+41
-69
lines changed

3 files changed

+41
-69
lines changed
 

‎index.html

+14-56
Original file line numberDiff line numberDiff line change
@@ -5,75 +5,44 @@
55
<title>React-custom-scroll by rommguy</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen">
8-
<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
8+
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
99
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
1010
<link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
1111
</head>
1212
<body>
1313
<section class="page-header">
1414
<h1 class="project-name">React-custom-scroll</h1>
15-
<h2 class="project-tagline">Custom scroll React component</h2>
15+
<h2 class="project-tagline">Easily customize the browser scroll bar with native OS scroll behavior</h2>
1616
<a href="https://github.com/rommguy/react-custom-scroll" class="btn">View on GitHub</a>
1717
<a href="https://github.com/rommguy/react-custom-scroll/zipball/master" class="btn">Download .zip</a>
1818
<a href="https://github.com/rommguy/react-custom-scroll/tarball/master" class="btn">Download .tar.gz</a>
1919
</section>
2020

2121
<section class="main-content">
22-
<h1>
23-
<a id="react-custom-scroll" class="anchor" href="#react-custom-scroll" aria-hidden="true"><span class="octicon octicon-link"></span></a>React-Custom-Scroll</h1>
22+
<h3>
23+
<a id="welcome-to-github-pages" class="anchor" href="#welcome-to-github-pages" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Welcome to GitHub Pages.</h3>
2424

25-
<p>An easily designable, cross browser (!!), custom scroll with ReactJS<br>
26-
Animations and scroll rate <strong>exactly</strong> like native scroll </p>
27-
28-
<h5>
29-
<a id="see-a-working-demo" class="anchor" href="#see-a-working-demo" aria-hidden="true"><span class="octicon octicon-link"></span></a>See a <a href="http://rommguy.github.io/react-custom-scroll/example/demo.html">working demo</a>
30-
</h5>
25+
<p>This automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here <a href="https://guides.github.com/features/mastering-markdown/">using GitHub Flavored Markdown</a>, select a template crafted by a designer, and publish. After your page is generated, you can check out the new <code>gh-pages</code> branch locally. If you’re using GitHub Desktop, simply sync your repository and you’ll see the new branch.</p>
3126

3227
<h3>
33-
<a id="why-do-i-need-this-" class="anchor" href="#why-do-i-need-this-" aria-hidden="true"><span class="octicon octicon-link"></span></a>Why do I need this ?</h3>
28+
<a id="designer-templates" class="anchor" href="#designer-templates" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Designer Templates</h3>
3429

35-
<ul>
36-
<li>Same design on all browsers</li>
37-
<li>Scrollbar above content instead of floating to the side - same layout on scrolled content as not scrolled content</li>
38-
</ul>
30+
<p>We’ve crafted some handsome templates for you to use. Go ahead and click 'Continue to layouts' to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved.</p>
3931

4032
<h3>
41-
<a id="how-to-use-" class="anchor" href="#how-to-use-" aria-hidden="true"><span class="octicon octicon-link"></span></a>How to use ?</h3>
42-
43-
<p>wrap your content with the custom scroll component
44-
remove overflow style properties from your content root component - The custom scroll will take care of it</p>
33+
<a id="creating-pages-manually" class="anchor" href="#creating-pages-manually" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Creating pages manually</h3>
4534

46-
<pre><code>&lt;customScroll&gt;
47-
your content
48-
&lt;/customScroll&gt;
49-
50-
</code></pre>
35+
<p>If you prefer to not use the automatic generator, push a branch named <code>gh-pages</code> to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.</p>
5136

5237
<h3>
53-
<a id="options-react-props" class="anchor" href="#options-react-props" aria-hidden="true"><span class="octicon octicon-link"></span></a>Options (react props)</h3>
54-
55-
<ul>
56-
<li>allowOuterScroll : boolean, default false. Blocks outer scroll while scrolling the content</li>
57-
<li>heightRelativeToParent : string, default undefined. Content height limit is relative to parent - the value should be the height limit.</li>
58-
<li>onScroll - function, default undefined. Listener that will be called on each scroll.</li>
59-
<li>addScrolledClass - boolean, default false. If true, will add a css class 'content-scrolled' while being scrolled.</li>
60-
</ul>
38+
<a id="authors-and-contributors" class="anchor" href="#authors-and-contributors" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Authors and Contributors</h3>
6139

62-
<h5>
63-
<a id="example-for-heightrelativetoparent" class="anchor" href="#example-for-heightrelativetoparent" aria-hidden="true"><span class="octicon octicon-link"></span></a>Example for heightRelativeToParent</h5>
64-
65-
<pre><code>&lt;customScroll heightRelativeToParent="calc(100% - 20px)""&gt;
66-
your content
67-
&lt;/customScroll&gt;
68-
</code></pre>
40+
<p>You can <a href="https://help.github.com/articles/basic-writing-and-formatting-syntax/#mentioning-users-and-teams" class="user-mention">@mention</a> a GitHub username to generate a link to their profile. The resulting <code>&lt;a&gt;</code> element will link to the contributor’s GitHub Profile. For example: In 2007, Chris Wanstrath (<a href="https://github.com/defunkt" class="user-mention">@defunkt</a>), PJ Hyett (<a href="https://github.com/pjhyett" class="user-mention">@pjhyett</a>), and Tom Preston-Werner (<a href="https://github.com/mojombo" class="user-mention">@mojombo</a>) founded GitHub.</p>
6941

7042
<h3>
71-
<a id="it-doesnt-work-please-help-me" class="anchor" href="#it-doesnt-work-please-help-me" aria-hidden="true"><span class="octicon octicon-link"></span></a>It doesn't work, please help me</h3>
43+
<a id="support-or-contact" class="anchor" href="#support-or-contact" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Support or Contact</h3>
7244

73-
<ul>
74-
<li>Check if you forgot to remove 'overflow' properties from the content root element.</li>
75-
<li>Check if your height limit is relative to parent, and you didn't use heightRelativeToParent prop.</li>
76-
</ul>
45+
<p>Having trouble with Pages? Check out our <a href="https://help.github.com/pages">documentation</a> or <a href="https://github.com/contact">contact support</a> and we’ll help you sort it out.</p>
7746

7847
<footer class="site-footer">
7948
<span class="site-footer-owner"><a href="https://github.com/rommguy/react-custom-scroll">React-custom-scroll</a> is maintained by <a href="https://github.com/rommguy">rommguy</a>.</span>
@@ -83,17 +52,6 @@ <h3>
8352

8453
</section>
8554

86-
<script type="text/javascript">
87-
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
88-
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
89-
</script>
90-
<script type="text/javascript">
91-
try {
92-
var pageTracker = _gat._getTracker("UA-63606990-1");
93-
pageTracker._trackPageview();
94-
} catch(err) {}
95-
</script>
96-
55+
9756
</body>
9857
</html>
99-

‎params.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"name": "React-custom-scroll",
3+
"tagline": "Easily customize the browser scroll bar with native OS scroll behavior",
4+
"body": "### Welcome to GitHub Pages.\r\nThis automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here [using GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/), select a template crafted by a designer, and publish. After your page is generated, you can check out the new `gh-pages` branch locally. If you’re using GitHub Desktop, simply sync your repository and you’ll see the new branch.\r\n\r\n### Designer Templates\r\nWe’ve crafted some handsome templates for you to use. Go ahead and click 'Continue to layouts' to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved.\r\n\r\n### Creating pages manually\r\nIf you prefer to not use the automatic generator, push a branch named `gh-pages` to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.\r\n\r\n### Authors and Contributors\r\nYou can @mention a GitHub username to generate a link to their profile. The resulting `<a>` element will link to the contributor’s GitHub Profile. For example: In 2007, Chris Wanstrath (@defunkt), PJ Hyett (@pjhyett), and Tom Preston-Werner (@mojombo) founded GitHub.\r\n\r\n### Support or Contact\r\nHaving trouble with Pages? Check out our [documentation](https://help.github.com/pages) or [contact support](https://github.com/contact) and we’ll help you sort it out.\r\n",
5+
"note": "Don't delete this file! It's used internally to help with page regeneration."
6+
}

‎stylesheets/github-light.css

+21-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,25 @@
11
/*
2-
Copyright 2014 GitHub Inc.
3-
4-
Licensed under the Apache License, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
6-
You may obtain a copy of the License at
7-
8-
http://www.apache.org/licenses/LICENSE-2.0
9-
10-
Unless required by applicable law or agreed to in writing, software
11-
distributed under the License is distributed on an "AS IS" BASIS,
12-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13-
See the License for the specific language governing permissions and
14-
limitations under the License.
2+
The MIT License (MIT)
3+
4+
Copyright (c) 2015 GitHub, Inc.
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
SOFTWARE.
1523
1624
*/
1725

0 commit comments

Comments
 (0)
Please sign in to comment.