“The best revenge is massive success.”
HTML CSS Ruby JavaScript
Latest commit 707581f Oct 12, 2016 @vis-kid vis-kid committed on GitHub Merge pull request #219 from vis-kid/ew-fix-navbar-spacing-small-devices
Fix navbar spacing for small devices
Permalink
Failed to load latest commit information.
_includes Extract legend.css into Sass partial Oct 4, 2016
_layouts WIP layout quickfix for subpages Aug 15, 2016
_posts mention release on blog Mar 15, 2013
_sass Fix navbar spacing for small devices Oct 12, 2016
api API docs are at railsapi.com now Mar 7, 2010
contrib Fix some typos Feb 25, 2014
css Fix navbar spacing for small devices Oct 12, 2016
images Replace sinatra bg graphic Jul 28, 2016
js Add js for menu on small screens Aug 16, 2016
.gitignore Update gitignore to exclude node_modules Aug 4, 2016
CNAME Fix whitespace error in CNAME file :) Jan 30, 2009
Gemfile Add Rake to Gemfile Aug 12, 2016
Gemfile.lock Add Rake to Gemfile Aug 12, 2016
README.md Update README after .css extractions Oct 4, 2016
Rakefile Change 'jp' code to 'ja' Mar 25, 2014
Thorfile better editor handling for blog:new; fixes #65 Oct 19, 2012
_config.yml Add exclude rules to avoid Jekyll compilation Aug 12, 2016
about.markdown add links to actual GitHub profiles in about page Apr 29, 2014
blog.html Add Read more button to blog excerpts Aug 17, 2016
book.html Use herokuapp link for sinatra book May 19, 2016
changes.html CHANGES is on github now Mar 7, 2010
configuration.markdown Updated links from Rubyforge to Rubydoc Oct 21, 2014
contributing.markdown Use herokuapp link for sinatra book May 19, 2016
documentation.markdown Fix Peepcode link Aug 18, 2016
example.markdown Add example markdown page Jan 19, 2009
extensions-wild.markdown Shakedown whole bunch of links and repo URLs Dec 14, 2012
extensions.markdown Fixed a typo in the extensions doc Apr 17, 2015
faq.markdown Update FAQ to fix typo in partials answer Mar 29, 2016
feed.xml Atom feed for blog Jan 22, 2009
gulpfile.js Remove rule to watch .scss files as well Oct 4, 2016
index.html Change curly quotes to straight quotes in example Aug 17, 2016
intro-de.html update documentation and release history Apr 8, 2014
intro-es.html update documentation and release history Apr 8, 2014
intro-fr.html update documentation and release history Apr 8, 2014
intro-hu.html update documentation and release history Apr 8, 2014
intro-ja.html update documentation and release history Apr 8, 2014
intro-ko.html update documentation and release history Apr 8, 2014
intro-pt-br.html update documentation and release history Apr 8, 2014
intro-pt-pt.html update documentation and release history Apr 8, 2014
intro-ru.html update documentation and release history Apr 8, 2014
intro-zh.html update documentation and release history Apr 8, 2014
intro.html update documentation and release history Apr 8, 2014
one-oh-faq.markdown Minor fixes for one-oh-faq Apr 2, 2010
package.json Add Browsersync for livereload functionality Aug 21, 2016
testing.markdown fix a couple of broken links Jun 9, 2014
wild.markdown Merge pull request #206 from JessicaParker/patch-1 Sep 20, 2016

README.md

Sinatra Website / Documentation

This repo contains the Sinatra website and documentation sources published at http://sinatra.github.com/.

Working Locally

Grab the sources from GitHub:

$ git clone git://github.com/sinatra/sinatra.github.com.git
$ cd sinatra.github.com

Make sure you have the bundler gem installed on your machine:

$ gem install bundler

Install dependencies:

$ bundle install

Run the test server:

$ rake server

Changes are immediately available at:

http://localhost:4000/sinatra.github.com/

Sass / CSS / Gulp

It would be appreciated if you could introduce your changes using the indented Sass syntax (.sass) in one of the existing Sass partials or if needed via new ones of your own. Not a friend of curlies and stuff.

Gulp was set up to streamline your build process. Simply run:

$ gulp watch

gulp watch triggers a couple of processes:

  • After changes have been introduced in the _sass directory, it first builds uncompressed .css files from the corresponding .sass files and puts them into /css/development.
  • Gulp also watches any changes made in the /css/development directory.
  • In turn, any changes in /css/development will get compressed, prefixed and purified of any obsolete style declarations before being placed in their final destination at /css.
  • Your site is reloaded automatically using Browsersync which watches any changes to .css files in /css. No need to install any additional gimmicks.

That means Gulp is configured so that you can either work on .sass files in the /_sass directory or on .css files directly in the /css/development directory. If you want to introduce changes in /css/development, you need to create new filenames to avoid being overwritten when new versions of Sass files get built.

Contributing

See GitHub's "Fork A Repo" for more information.

Creating Blog Posts

Blog posts are stored under the _posts directory. To create a new blog post and open your $EDITOR, use:

thor blog:new 'Blog Post Title'

This requires Thor:

$ gem install thor

Prebuilt Files

You will need thor, rdoc, haml and mislav's hanna gem to rebuild static files and the API docs:

$ gem install thor
$ gem install rdoc -v 2.3.0
$ gem install haml -v 2.0.4
$ gem install mislav-hanna --source=http://gems.github.com/

The prebuilt file sources are maintained under the sinatra and sinatra-book projects. To pull in the latest versions and build them:

rake pull build

The generated files under the "_includes" and "api" directories need to be committed after building. To regenerate and add those files to your index for the next commit:

rake regen