Skip to content
Browse files

Initial commit

  • Loading branch information...
0 parents commit ec383f1b4bac5b45964c974fe3fab3ee89851351 @wycats wycats committed Jan 4, 2011
1 .gitignore
@@ -0,0 +1 @@
+output
7 Gemfile
@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+if ENV["GUIDES_PATH"]
+ gem "guides", :path => ENV["GUIDES_PATH"]
+else
+ gem "guides", :git => "git://github.com/wycats/guides.git"
+end
48 Gemfile.lock
@@ -0,0 +1,48 @@
+GIT
+ remote: git://github.com/wycats/guides.git
+ revision: 5ad7ae9bc10786501d16fb2fd06b727627c93703
+ specs:
+ guides (0.5.0)
+ RedCloth (~> 4.1.1)
+ actionpack (~> 3.0.0)
+ activesupport (~> 3.0.0)
+ rack (~> 1.2.1)
+ thor (~> 0.14.6)
+
+GEM
+ remote: http://rubygems.org/
+ specs:
+ RedCloth (4.1.9)
+ abstract (1.0.0)
+ actionpack (3.0.3)
+ activemodel (= 3.0.3)
+ activesupport (= 3.0.3)
+ builder (~> 2.1.2)
+ erubis (~> 2.6.6)
+ i18n (~> 0.4)
+ rack (~> 1.2.1)
+ rack-mount (~> 0.6.13)
+ rack-test (~> 0.5.6)
+ tzinfo (~> 0.3.23)
+ activemodel (3.0.3)
+ activesupport (= 3.0.3)
+ builder (~> 2.1.2)
+ i18n (~> 0.4)
+ activesupport (3.0.3)
+ builder (2.1.2)
+ erubis (2.6.6)
+ abstract (>= 1.0.0)
+ i18n (0.5.0)
+ rack (1.2.1)
+ rack-mount (0.6.13)
+ rack (>= 1.0.0)
+ rack-test (0.5.7)
+ rack (>= 1.0)
+ thor (0.14.6)
+ tzinfo (0.3.23)
+
+PLATFORMS
+ ruby
+
+DEPENDENCIES
+ guides!
9 Rakefile
@@ -0,0 +1,9 @@
+desc "start from a freshly generated Rails Guides setup"
+task :bootstrap do
+ FileUtils.rm_rf(Dir["{assets,source,guides.yml}"])
+ system "ruby bin/guides new . --name 'SproutCore Guides'"
+ FileUtils.cp("bootstrap/guides.yml", "guides.yml")
+ FileUtils.cp("bootstrap/overrides.css", "assets/stylesheets/overrides.style.css")
+ FileUtils.cp("bootstrap/logo.png", "assets/images/logo.png")
+ system "ruby bin/guides generate --clean"
+end
BIN assets/images/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0 assets/stylesheets/overrides.print.css
No changes.
41 assets/stylesheets/overrides.style.css
@@ -0,0 +1,41 @@
+dd img {
+ float: left;
+ height: 36px;
+ margin-right: 10px;
+}
+
+#header {
+ background: none;
+ background-color: #343940;
+ border-top: 2px solid #464B52;
+}
+
+#header .nav a {
+ color: #C3C3C3;
+}
+
+#header .nav .index, #header .nav .index a {
+ background-color: #2A8008;
+ background-image: none;
+ color: #fff;
+}
+
+#guides {
+ background-color: #2A8008;
+ color: #5FBB58;
+}
+
+#guides hr {
+ background-color: #5FBB58;
+}
+
+#mainCol a, #subCol a, #feature a {
+ color: #0A6008;
+}
+
+#header h1 {
+ background-image: url(../images/logo.png);
+ background-size: auto 120px;
+ background-position: -25px -25px;
+ overflow: visible
+}
16 bin/erubis
@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'erubis' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+ Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('erubis', 'erubis')
16 bin/guides
@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guides' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+ Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guides', 'guides')
16 bin/rackup
@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+ Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rack', 'rackup')
16 bin/rake2thor
@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake2thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+ Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'rake2thor')
16 bin/redcloth
@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'redcloth' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+ Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('RedCloth', 'redcloth')
16 bin/thor
@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+ Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'thor')
49 bootstrap/guides.yml
@@ -0,0 +1,49 @@
+title: SproutCore Guides
+description: These guides are designed to help you get up and running and feeling productive with SproutCore.
+
+authors:
+ Documentation Team:
+ - name: Yehuda Katz
+ nick: wycats
+ description: Yehuda works for Strobe and is a member of the SproutCore core team.
+ Designers:
+ - name: Jason Zimdars
+ nick: jz
+ description: Jason Zimdars is an experienced creative director and web designer who has lead UI and UX design for numerous websites and web applications. You can see more of his design and writing at <a href="http://www.thinkcage.com/">Thinkcage.com</a> or follow him on <a href="http://twitter.com/JZ">Twitter</a>
+
+index:
+ Start Here:
+ - title: Getting Started
+ url: getting_started
+ text: Jump start your SproutCore development by playing along as we build a fully functional Todo List application.
+ construction: true
+ - title: Core Concepts
+ url: core_concepts
+ text: In this guide, we will touch on many of the core concepts of SproutCore like bindings and the run loop. We'll cover just enough to get you going with bogging down in the details. If you want to learn more, take a look at the detailed overviews of these concepts in the "Digging Deeper" section.
+ construction: true
+ - title: Using Amber
+ url: amber
+ text: Learn how to use the lightweight Amber framework to build applications without the full SproutCore stack.
+ construction: true
+ Models:
+ - title: SproutCore Records
+ url: records
+ text: The SproutCore data framework is a full-featured ORM-like framework for working with data in the SproutCore Learn about the SproutCore data framework and how you can use it to interact with your data sources.
+ construction: true
+ - title: Hooking Up to a Backend
+ url: data_source
+ text: This guide covers how to create a SproutCore data source, which will retrieve data from your servers and make them available to the SproutCore Records you designed in the previous guide.
+ construction: true
+ - title: Using Fixtures
+ url: fixtures
+ text: In order to facilitate rapid development, SproutCore provides a facility for using pre-set fixture data as your data source. This guide covers how to set up your fixtures, and how to replace them with your real server once you're ready to get going.
+ construction: true
+ Views:
+ - title: Core View Concepts
+ url: views
+ text: In this guide, we will cover the basics of SproutCore views, and show you how to customize the built-in SproutCore views for your own use.
+ construction: true
+ - title: Building Your Own Views
+ url: custom_views
+ text: Most applications will quickly go beyond the built-in SproutCore views. In this guide, we will cover how to build and style your own views.
+ construction: true
BIN bootstrap/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 bootstrap/overrides.css
@@ -0,0 +1,41 @@
+dd img {
+ float: left;
+ height: 36px;
+ margin-right: 10px;
+}
+
+#header {
+ background: none;
+ background-color: #343940;
+ border-top: 2px solid #464B52;
+}
+
+#header .nav a {
+ color: #C3C3C3;
+}
+
+#header .nav .index, #header .nav .index a {
+ background-color: #2A8008;
+ background-image: none;
+ color: #fff;
+}
+
+#guides {
+ background-color: #2A8008;
+ color: #5FBB58;
+}
+
+#guides hr {
+ background-color: #5FBB58;
+}
+
+#mainCol a, #subCol a, #feature a {
+ color: #0A6008;
+}
+
+#header h1 {
+ background-image: url(../images/logo.png);
+ background-size: auto 120px;
+ background-position: -25px -25px;
+ overflow: visible
+}
49 guides.yml
@@ -0,0 +1,49 @@
+title: SproutCore Guides
+description: These guides are designed to help you get up and running and feeling productive with SproutCore.
+
+authors:
+ Documentation Team:
+ - name: Yehuda Katz
+ nick: wycats
+ description: Yehuda works for Strobe and is a member of the SproutCore core team.
+ Designers:
+ - name: Jason Zimdars
+ nick: jz
+ description: Jason Zimdars is an experienced creative director and web designer who has lead UI and UX design for numerous websites and web applications. You can see more of his design and writing at <a href="http://www.thinkcage.com/">Thinkcage.com</a> or follow him on <a href="http://twitter.com/JZ">Twitter</a>
+
+index:
+ Start Here:
+ - title: Getting Started
+ url: getting_started
+ text: Jump start your SproutCore development by playing along as we build a fully functional Todo List application.
+ construction: true
+ - title: Core Concepts
+ url: core_concepts
+ text: In this guide, we will touch on many of the core concepts of SproutCore like bindings and the run loop. We'll cover just enough to get you going with bogging down in the details. If you want to learn more, take a look at the detailed overviews of these concepts in the "Digging Deeper" section.
+ construction: true
+ - title: Using Amber
+ url: amber
+ text: Learn how to use the lightweight Amber framework to build applications without the full SproutCore stack.
+ construction: true
+ Models:
+ - title: SproutCore Records
+ url: records
+ text: The SproutCore data framework is a full-featured ORM-like framework for working with data in the SproutCore Learn about the SproutCore data framework and how you can use it to interact with your data sources.
+ construction: true
+ - title: Hooking Up to a Backend
+ url: data_source
+ text: This guide covers how to create a SproutCore data source, which will retrieve data from your servers and make them available to the SproutCore Records you designed in the previous guide.
+ construction: true
+ - title: Using Fixtures
+ url: fixtures
+ text: In order to facilitate rapid development, SproutCore provides a facility for using pre-set fixture data as your data source. This guide covers how to set up your fixtures, and how to replace them with your real server once you're ready to get going.
+ construction: true
+ Views:
+ - title: Core View Concepts
+ url: views
+ text: In this guide, we will cover the basics of SproutCore views, and show you how to customize the built-in SproutCore views for your own use.
+ construction: true
+ - title: Building Your Own Views
+ url: custom_views
+ text: Most applications will quickly go beyond the built-in SproutCore views. In this guide, we will cover how to build and style your own views.
+ construction: true
17 source/_clickable_index.html.erb
@@ -0,0 +1,17 @@
+<dl class="L">
+ <% lgroup.each do |group, guides| %>
+ <dt><%= group %></dt>
+ <% guides.each do |guide| %>
+ <dd><%= link_to guide["title"], "#{guide["url"]}.html" %></dd>
+ <% end %>
+ <% end %>
+</dl>
+<dl class="R">
+ <% rgroup.each do |group, guides| %>
+ <dt><%= group %></dt>
+ <% guides.each do |guide| %>
+ <dd><%= link_to guide["title"], "#{guide["url"]}.html" %></dd>
+ <% end %>
+ <% end %>
+</dl>
+
16 source/_full_index.html.erb
@@ -0,0 +1,16 @@
+<% guides.each do |name, list| %>
+ <h3><%= name %></h3>
+
+ <dl>
+ <% list.each do |guide| %>
+ <dt><%= link_to guide["title"], "#{guide["url"]}.html" %></dt>
+ <dd>
+ <% if guide["construction"] %>
+ <img src="images/construction.png" />
+ <% end %>
+ <p><%= guide["text"] %></p>
+ </dd>
+ <% end %>
+ </dl>
+<% end %>
+
24 source/_sections.html.erb
@@ -0,0 +1,24 @@
+<%# This will replace the <title> element in your page. By default, it uses the title key in your guides.yml %>
+<%= content_for :page_title do %><%= Guides.meta["title"] %><% end %>
+
+<%# This content will go in the top navigation area. Leave it blank if you don't want nav %>
+<%= content_for :top_nav do %>
+<% end %>
+
+<%# This content will be used when you mark your guides as belonging to an edge release of your project. It defaults
+ to showing a diagonal "edge" badge %>
+<%= content_for :edge do %>
+ <div>
+ <img src="images/edge_badge.png" alt="edge-badge" id="edge-badge" />
+ </div>
+<% end %>
+
+<%= content_for :license do %>
+ <p>This work is licensed under a
+ <%= link_to "Creative Commons Attribution Share Alike 3.0", "http://creativecommons.org/licenses/by-sa/3.0/" %>
+ license.
+ </p>
+ <p>
+ <%# Any additional trademark information should be entered here %>
+ </p>
+<% end %>
47 source/contribute.textile
@@ -0,0 +1,47 @@
+h2. Contribute
+
+Replace this with some introductory material on contributing
+
+endprologue.
+
+h3. How to Contribute?
+
+* Make a list
+* of useful information
+* on contributing
+
+h3. What to Contribute?
+
+* We need authors, editors, proofreaders, and translators. Adding a single paragraph of quality content to a guide is a good way to get started.
+* The easiest way to start is by improving an existing guide:
+** Improve the structure to make it more coherent.
+** Add missing information.
+** Correct any factual errors.
+** Fix typos or improve style.
+** Bring it up to date with the latest Edge Rails.
+* We're also open to suggestions for entire new guides:
+** Contact REPLACE_THIS to get your idea approved. See the Contact section below.
+
+h3. How is the process?
+
+* Describe the process
+* you will use
+* in this section
+
+h3. Rules
+
+* Guides are licensed under a Creative Commons Attribution-Share Alike 3.0 License.
+* If you're not sure whether a guide is actively being worked on, stop by IRC and ask.
+* Set up additional rules here
+
+TODO: Set up some conventions for authors to follow. https://github.com/lifo/docrails/wiki/rails-guides-conventions Is a good starting poing
+
+h3. Mailing List
+
+TODO: Specify the mailing list where people can ask about the efforts
+
+h3. Contact
+
+* IRC : TODO
+* Twitter: TODO
+* Email : TODO
21 source/credits.html.erb
@@ -0,0 +1,21 @@
+<% content_for :page_title do %>
+<%= Guides.meta["title"] %>: Credits
+<% end %>
+
+<% content_for :header_section do %>
+<h2>Credits</h2>
+
+<p>We'd like to thank the following people for their tireless contributions to this project.</p>
+<% end %>
+
+<h3 class="section"><%= Guides.meta["team_name"] %></h3>
+
+<% Guides.meta["authors"].each do |group, authors| %>
+ <h3 class="section"><%= group %></h3>
+ <% authors.each do |author| %>
+ <%= author(author["name"], author["nick"]) do %>
+ <%= author["description"].html_safe %>
+ <% end %>
+ <% end %>
+<% end %>
+
1 source/index.html.erb
@@ -0,0 +1 @@
+<%= render "full_index", :guides => Guides.meta["index"] %>
82 source/layout.html.erb
@@ -0,0 +1,82 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+
+<title><%= yield(:page_title) %></title>
+
+<link rel="stylesheet" type="text/css" href="stylesheets/style.css" />
+<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
+<link rel="stylesheet" type="text/css" href="stylesheets/overrides.style.css" />
+<link rel="stylesheet" type="text/css" href="stylesheets/overrides.print.css" media="print" />
+
+
+<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shCore.css" />
+<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shThemeRailsGuides.css" />
+</head>
+<body class="guide">
+ <% if @edge %>
+ <div>
+ <img src="images/edge_badge.png" alt="edge-badge" id="edge-badge" />
+ </div>
+ <% end %>
+ <div id="topNav">
+ <div class="wrapper">
+ <%= yield :top_nav %>
+ </div>
+ </div>
+ <div id="header">
+ <div class="wrapper clearfix">
+ <h1><a href="index.html" title="Return to home page"><%= Guides.meta["title"] %></a></h1>
+ <p class="hide"><a href="#mainCol">Skip navigation</a>.</p>
+ <ul class="nav">
+ <li><a href="index.html">Home</a></li>
+ <li class="index"><a href="index.html" onclick="guideMenu(); return false;" id="guidesMenu">Guides Index <span id="guidesArrow">&#9656;</span></a>
+ <div id="guides" class="clearfix" style="display: none;">
+ <hr />
+ <%= clickable_index %>
+ </div>
+ </li>
+ <li><a href="contribute.html">Contribute</a></li>
+ <li><a href="credits.html">Credits</a></li>
+ </ul>
+ </div>
+ </div>
+ <hr class="hide" />
+
+ <div id="feature">
+ <div class="wrapper">
+ <h2><%= Guides.meta["title"] %></h2>
+ <p><%= Guides.meta["description"] %></p>
+ </div>
+ </div>
+
+ <div id="container">
+ <div class="wrapper">
+ <div id="mainCol">
+ <%= yield %>
+ </div>
+ </div>
+ </div>
+
+ <hr class="hide" />
+ <div id="footer">
+ <div class="wrapper">
+ <%= yield :license %>
+ </div>
+ </div>
+
+ <script type="text/javascript" src="javascripts/guides.js"></script>
+ <script type="text/javascript" src="javascripts/syntaxhighlighter/shCore.js"></script>
+ <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushRuby.js"></script>
+ <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushJScript.js"></script>
+ <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushXml.js"></script>
+ <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushSql.js"></script>
+ <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushPlain.js"></script>
+ <script type="text/javascript">
+ SyntaxHighlighter.all()
+ </script>
+</body>
+</html>

0 comments on commit ec383f1

Please sign in to comment.
Something went wrong with that request. Please try again.