https://github.com/faradayio/numbers-staging

Staging environment for the blog
https://github.com/faradayio/numbers-staging

Last synced: about 1 month ago
JSON representation

Staging environment for the blog

• Host: GitHub
• URL: https://github.com/faradayio/numbers-staging
• Owner: faradayio
• Created: 2010-09-06T17:26:52.000Z (almost 16 years ago)
• Default Branch: gh-pages
• Last Pushed: 2012-02-13T18:19:01.000Z (over 14 years ago)
• Last Synced: 2025-07-27T07:32:49.492Z (11 months ago)
• Language: Ruby
• Homepage: http://brighterplanet.github.com/numbers-staging
• Size: 15.3 MB
• Stars: 1
• Watchers: 10
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# numbers

This repository drives Brighter Planet's blog, [Safety in Numbers](http://numbers.brighterplanet.com) via [Jekyll](http://github.com/mojombo/jekyll) on [GitHub Pages](http://pages.github.com).

## To start blogging

    $ git clone http://github.com/brighterplanet/numbers.git

## To add a post

Always start out with

    $ git pull

You're going to create a file in the _posts directory named like:

    year-month-day-here-is-my-title.extension

    

So, for example:

    $ mate _posts/2010-07-23-new-blog.md

    

The extension says what markup language you want to use. "md" is for Markdown, which is my fave, but you can use "textile," "html," etc.

At the top of your file you'll need a metadata section that looks like this:

    ---

    title: Relaunching the blog

    author: Andy

    layout: post

    categories: meta

    ---

(The three dashes at the top and bottom are important.)

Author is your first name, layout should always stay "post", and categories (if you want any) can either be a single category or a list of categories in brackets (e.g. [rails, middleware]). If you use categories, make sure they've been created (see below).

Whatever goes below this metadata section is your post.

## To specify what goes in "Read More"

Wrap the part that gets hidden with these HTML comments: (verbatim!)

    ---

    title: some post

    layout: post

    ---

    Some intro, this will be visible on the index page.

    

    More content, this will not be visible on the index page.

    

The "more end" comment should go at the bottom of the document, below everything else.

See 2011-01-13-announcing-our-new-parcel-shipment-model.markdown for a good example and make sure that you always put BOTH comments, "more start" and then "more end".

The process is taken from http://kaspa.rs/2011/04/jekyll-hacks-html-excerpts/

## To preview your post/changes

    $ jekyll --server

Then go to [localhost:4000](http://localhost:4000)

## To push your post/changes

    $ git add _posts/2010-01-01-my-awesome-post.md

    $ git commit -m "First draft of 'My Awesome Post'"

    $ git push

    

Then go to [numbers.brighterplanet.com](http://numbers.brighterplanet.com)

## To add a category/tag

Open _config.yml and add your tag to the list:

    cats: [rails, middleware, meta, awesometag]

    

Copy rails.html to awesometag.html, change the title at the top and the header on line 5.

## When in doubt

Just look at older posts for guidance