Skip to content
Newer
Older
100644 122 lines (72 sloc) 3.78 KB
c1ff721 @rtomayko Add Documentation page; remove Book and RDoc from nav
rtomayko authored
1 ---
2 title: "Sinatra: Documentation"
3 layout: default
4 ---
5
6 Documentation
7 =============
8
2274882 @rtomayko Use "README" instead of "Introduction"
rtomayko authored
9 ### [README](intro.html)
c1ff721 @rtomayko Add Documentation page; remove Book and RDoc from nav
rtomayko authored
10
11 A whirlwind tour of Sinatra's most interesting features.
12
813dc52 @rtomayko Move the FAQ under the README on the doc index
rtomayko authored
13 ### [Frequently Asked Questions](faq.html)
14
15 Answers to those questions most frequently asked on the mailing list and
16 in `#sinatra`.
17
a162e26 @rtomayko Link to configuration, testing, and extensions topics from doc index
rtomayko authored
18 ### [Options and Configuration](configuration.html)
19
20 Detailed documentation on all of Sinatra's built-in options and using `set`,
21 `enable`, and `disable` to configure them.
22
5ccfd07 @dylanegan Rank API link higher on the documentation list.
dylanegan authored
23 ### [API Documentation](/api/index.html)
24
25 Generated from Sinatra's source with RDoc. The
26 [Rack API docs](http://rack.rubyforge.org/doc/) should also be consulted.
27
28 Also available with an alternate template at <http://railsapi.com/sinatra>.
29
4e899bf @rtomayko Link to Testing doc again and tidy up notes about deprecation
rtomayko authored
30 ### [Testing Sinatra with Rack::Test](testing.html)
31
32 Guide to testing Sinatra apps.
33
a162e26 @rtomayko Link to configuration, testing, and extensions topics from doc index
rtomayko authored
34 ### [Writing Extensions](extensions.html)
78cbc0e @dashdotat Bootstrapping of changes to doc for testing
dashdotat authored
35
a162e26 @rtomayko Link to configuration, testing, and extensions topics from doc index
rtomayko authored
36 How to add new functionality to Sinatra using the extension APIs.
746524d @rtomayko Remove testing link from doc index temporarily (for review)
rtomayko authored
37
2359d7f @rtomayko Reorganize documentation page a bit
rtomayko authored
38 ### [Release Notes](changes.html)
39
40 Detailed change log for each Sinatra release generated from the `CHANGES`
41 file.
42
03a6092 @rtomayko Misc cleanup of Extensions in the Wild stuff
rtomayko authored
43 ### [In the Wild](/wild.html)
44
45 List of applications, libraries, websites and companies using Sinatra.
46
be72597 @rtomayko move extensions in the wild page to extensions-wild.html
rtomayko authored
47 ### [Extensions in the Wild](/extensions-wild.html)
03a6092 @rtomayko Misc cleanup of Extensions in the Wild stuff
rtomayko authored
48
49 List of Sinatra extensions, typically available as gems.
50
2359d7f @rtomayko Reorganize documentation page a bit
rtomayko authored
51 ### [The Sinatra Book](book.html) (_Work In Progress_)
c1ff721 @rtomayko Add Documentation page; remove Book and RDoc from nav
rtomayko authored
52
88254d0 @rtomayko Remove book section links from Documentation page
rtomayko authored
53 An in-depth look at building and deploying Sinatra applications.
54
55 <!--
a2a4d18 @rtomayko Add book TOC sections to Documentation page
rtomayko authored
56
7be4adb @rtomayko Link to Book from Documentation page sections
rtomayko authored
57 ### [Routes](book.html#routes) and [Filters](book.html#filters)
a2a4d18 @rtomayko Add book TOC sections to Documentation page
rtomayko authored
58
59 Using `get`, `put`, `post`, `delete` to define routes and `before`
60 to inspect/modify the request before routing is performed.
61
7be4adb @rtomayko Link to Book from Documentation page sections
rtomayko authored
62 ### [Helpers](book.html#helpers) and [Views](book.html#views)
a2a4d18 @rtomayko Add book TOC sections to Documentation page
rtomayko authored
63
64 Extracting commonly used logic into helper methods and managing
65 view code in external templates.
66
7be4adb @rtomayko Link to Book from Documentation page sections
rtomayko authored
67 ### [Configuration](book.html#configuration)
a2a4d18 @rtomayko Add book TOC sections to Documentation page
rtomayko authored
68
7be4adb @rtomayko Link to Book from Documentation page sections
rtomayko authored
69 Using `configure` blocks, settings options, and using Rack
70 middleware.
a2a4d18 @rtomayko Add book TOC sections to Documentation page
rtomayko authored
71
7be4adb @rtomayko Link to Book from Documentation page sections
rtomayko authored
72 ### [Error Handling](book.html#error_handling)
a2a4d18 @rtomayko Add book TOC sections to Documentation page
rtomayko authored
73
7be4adb @rtomayko Link to Book from Documentation page sections
rtomayko authored
74 How to create custom error pages or perform actions when certain
75 exceptions occur within your application.
a2a4d18 @rtomayko Add book TOC sections to Documentation page
rtomayko authored
76
7be4adb @rtomayko Link to Book from Documentation page sections
rtomayko authored
77 ### [Deployment](book.html#deployment)
a2a4d18 @rtomayko Add book TOC sections to Documentation page
rtomayko authored
78
79 How to deploy under Thin, Passenger, etc. using a Rackup file.
c1ff721 @rtomayko Add Documentation page; remove Book and RDoc from nav
rtomayko authored
80
88254d0 @rtomayko Remove book section links from Documentation page
rtomayko authored
81 -->
82
2359d7f @rtomayko Reorganize documentation page a bit
rtomayko authored
83 Screencasts and Presentations
84 -----------------------------
c1ff721 @rtomayko Add Documentation page; remove Book and RDoc from nav
rtomayko authored
85
b109667 @benschwarz Added notes for my talk on middlewares
benschwarz authored
86 ### [Sinatra, rack and middleware](http://www.slideshare.net/benschwarz/sinatra-rack-and-middleware-1509268)
87
88 Ben Schwarz presents Sinatra and his realisations of its inner workings in regard to
89 rack and rack middlware at Melbourne RORO shortly after Railsconf (US).
90
2359d7f @rtomayko Reorganize documentation page a bit
rtomayko authored
91 ### [RubyConf 08: Lightweight Web Services](http://rubyconf2008.confreaks.com/lightweight-web-services.html)
f2e12c1 @rtomayko Link to the adam/blake RubyConf talk and Prag screencasts
rtomayko authored
92
2274882 @rtomayko Use "README" instead of "Introduction"
rtomayko authored
93 Adam Wiggins and Blake Mizerany present Sinatra and
94 [RestClient](http://github.com/adamwiggins/rest-client/tree/master)
f2e12c1 @rtomayko Link to the adam/blake RubyConf talk and Prag screencasts
rtomayko authored
95 at RubyConf 2008. The talk details Sinatra's underlying philosophy and
96 reflects on using Sinatra to build real world applications.
97
2359d7f @rtomayko Reorganize documentation page a bit
rtomayko authored
98 ### [Classy Web Development with Sinatra](http://www.pragprog.com/screencasts/v-aksinatra/classy-web-development-with-sinatra) (Prag's Screencast Series)
f2e12c1 @rtomayko Link to the adam/blake RubyConf talk and Prag screencasts
rtomayko authored
99
100 Adam Keys and The Pragmatic Programmers have started a series of screencasts
101 on Sinatra. The first two episodes cover creating a tiny web app and creating
2359d7f @rtomayko Reorganize documentation page a bit
rtomayko authored
102 a REST service. <em>$5 a pop.</em>
103
124505a @sr Add foca's presentation
sr authored
104 ### [Sinatra at Locos x Rails](http://www.slideshare.net/godfoca/sinatra-1282891), in Buenos Aires
105
106 By [Nicolás Sanguinetti](http://github.com/foca), April 2009.
107
2359d7f @rtomayko Reorganize documentation page a bit
rtomayko authored
108 Around The Web
109 --------------
110
111 ### [RubyInside's 29 Links and Resources](http://www.rubyinside.com/sinatra-29-links-and-resources-for-a-quicker-easier-way-to-build-webapps-1371.html)
a2a4d18 @rtomayko Add book TOC sections to Documentation page
rtomayko authored
112
88254d0 @rtomayko Remove book section links from Documentation page
rtomayko authored
113 Peter Cooper's compendium with links to tutorials, example
7be4adb @rtomayko Link to Book from Documentation page sections
rtomayko authored
114 applications, and presentations.
a2a4d18 @rtomayko Add book TOC sections to Documentation page
rtomayko authored
115
fc04876 @cschneid Fix my name. I'm so vain.
cschneid authored
116 ### [Chris Schneider's Blog: GITTR](http://www.gittr.com/)
c1ff721 @rtomayko Add Documentation page; remove Book and RDoc from nav
rtomayko authored
117
2359d7f @rtomayko Reorganize documentation page a bit
rtomayko authored
118 Christopher's blog is a treasure-trove of useful Sinatra related
119 information.
d83baf1 @sr Link to "Using Compass for CSS in your Sinatra application" article
sr authored
120
121 ### [Using Compass for CSS in your Sinatra application](http://log.openmonkey.com/post/73462983/using-compass-for-css-in-your-sinatra-application)
Something went wrong with that request. Please try again.