Skip to content

Commit

Permalink
Added index for each sections.
Browse files Browse the repository at this point in the history
  • Loading branch information
ksoichiro committed May 3, 2015
1 parent 67cf290 commit c4deb40
Show file tree
Hide file tree
Showing 10 changed files with 74 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/_layout.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@
<li><ul><li class="topic"><a href="<%- baseUrl %>/docs/overview">Overview</a></li></ul></li>
<% for (var sectionSlug in public._data) { %>
<li>
<h4 class="section"><%- public._data[sectionSlug].title %></h4>
<h4 class="section"><a href="<%- baseUrl %>/docs/<%- sectionSlug %>/"><%- public._data[sectionSlug].title %></a></h4>
<ul>
<% for (var topicSlug in public.docs[sectionSlug]._data) { %>
<li class="topic"><a href="<%- baseUrl %>/docs/<%- sectionSlug %>/<%- topicSlug %>"><%- public.docs[sectionSlug]._data[topicSlug].title %></a></li>
<% if (topicSlug !== "index") { %>
<li class="topic"><a href="<%- baseUrl %>/docs/<%- sectionSlug %>/<%- topicSlug %>"><%- public.docs[sectionSlug]._data[topicSlug].title %></a></li>
<% } %>
<% } %>
</ul>
</li>
Expand Down
3 changes: 3 additions & 0 deletions docs/advanced/_data.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"index": {
"title": "Advanced techniques"
},
"sliding-up": {
"title": "Sliding up pattern"
},
Expand Down
8 changes: 8 additions & 0 deletions docs/advanced/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Advanced techniques

This section describes advanced scrolling techniques.
When you've done this topic, you could be be an expert of handling scrolls!
I'd appreciate it if you could suggest new patterns or improvements of the library.

1. [Sliding up pattern](../../docs/advanced/sliding-up.md)
1. [ViewPager pattern](../../docs/advanced/viewpager.md)
3 changes: 3 additions & 0 deletions docs/basic/_data.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"index": {
"title": "Basic techniques"
},
"show-hide-action-bar": {
"title": "Show and hide the Action Bar"
},
Expand Down
10 changes: 10 additions & 0 deletions docs/basic/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Basic techniques

This section explains the basic scrolling techniques.

1. [Show and hide the Action Bar](../../docs/basic/show-hide-action-bar.md)
1. [Translating the Toolbar](../../docs/basic/translating-toolbar.md)
1. [Translating itself](../../docs/basic/translating-itself.md)
1. [Parallax image](../../docs/basic/parallax-image.md)
1. [Sticky header](../../docs/basic/sticky-header.md)
1. [Filling gap on top of the Toolbar](../../docs/basic/filling-gap.md)
3 changes: 3 additions & 0 deletions docs/example/_data.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"index": {
"title": "Try the example app"
},
"google-play": {
"title": "Download from Google Play"
},
Expand Down
9 changes: 9 additions & 0 deletions docs/example/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Try the examples app

To understand how it works, let's see the existing example app
and check if there are some patterns you want to implement.

1. [Download from Google Play](../../docs/example/google-play.md)
1. [Download from wercker](../../docs/eaxmple/wercker.md)
1. [Build on Android Studio](../../docs/example/android-studio.md)
1. [Build on Eclipse](../../docs/example/eclipse.md)
23 changes: 23 additions & 0 deletions docs/overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
# Overview

Android-ObservableScrollView is a library to handle scroll position for Android library, and contains lots of examples to demonstrate how this library works.

However, creating awesome scrolling effects depends deeply on how you use it: layout, offset calculation to animate views, etc.

This documentation describes how to install this library and apply to your application.

## Try quickly

See [Quick start](../docs/quick-start/index.md) section first.

## See the complete examples

Download from Google Play or wercker for quick trial,
or you'd like to build it, see [Try the example app](../docs/example/index.md) section.

## Learn from basics

Okay, now you've setup environments, let's learn how to use it in your app.
See [Basic techniques](../docs/basic/index.md) section.

## Challenge complex and awesome techniques

If you'd like to create complex, awesome scrolling animation using ViewPager or something,
please check out [Advanced techniques](../docs/advanced/index.md) section.
3 changes: 3 additions & 0 deletions docs/quick-start/_data.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"index": {
"title": "Quick start"
},
"dependencies": {
"title": "Dependencies"
},
Expand Down
8 changes: 8 additions & 0 deletions docs/quick-start/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Quicks start

Thank you for having interest in this library!
In this section, I'll show some quick instructions for introducing this library into your app.

1. [Dependencies](../../docs/quick-start/dependencies.md)
1. [Layout](../../docs/quick-start/layout.md)
1. [Animation codes](../../docs/quick-start/animation.md)

0 comments on commit c4deb40

Please sign in to comment.