Skip to content
This repository

The akka.io site

Octocat-spinner-32 _includes Akka v2.3.2 release April 09, 2014
Octocat-spinner-32 _layouts Simpler download update September 30, 2013
Octocat-spinner-32 community fix up indentation in Spray AWS plugin April 03, 2014
Octocat-spinner-32 docs Akka v2.3.2 release April 09, 2014
Octocat-spinner-32 downloads remove Activator video and include Akka templates and old versions September 30, 2013
Octocat-spinner-32 faq Akka 2.3.0 release March 05, 2014
Octocat-spinner-32 news Akka v2.3.2 release April 09, 2014
Octocat-spinner-32 resources Make too large (or legendary) images fit the team pic space April 09, 2014
Octocat-spinner-32 team Akka v2.3.2 release April 09, 2014
Octocat-spinner-32 .gitignore pushing to github March 05, 2012
Octocat-spinner-32 404.html Akka v2.3.2 release April 09, 2014
Octocat-spinner-32 CNAME Add CNAME file for akka.io March 12, 2012
Octocat-spinner-32 README.md Update instructions on how to run Jekyll locally June 03, 2013
Octocat-spinner-32 _config.yml new community page March 12, 2014
Octocat-spinner-32 _config_local.yml Update instructions on how to run Jekyll locally June 03, 2013
Octocat-spinner-32 akka-0.10.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.0-M1.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.0-RC1.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.0-RC2.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.0-RC3.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.0-RC5.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.0-RC6.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.0.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.1-M1.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.1-RC1.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.1.1.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.1.2.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.1.3.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.1.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.2-RC2.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.2-RC3.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.2-RC4.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.2-RC5.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.2-RC6.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.2.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.3-RC1.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.3-RC2.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.3-RC3.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.3-RC4.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.3-RC5.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.3-RC6.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.3-RC7.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.3.1.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-1.3.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-2.0-M1.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-2.0-M2.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-2.0-M3.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-2.0-M4.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-2.0-RC1.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-2.0-RC2.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-2.0-RC3.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-2.0-RC4.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka-2.0.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 akka.xsd add schema files in their old place March 14, 2012
Octocat-spinner-32 index.md pushing to github March 05, 2012
README.md

AKKA.IO

This repository contains the source of the akka.io website. It's built using Jekyll, and designed with a touch of Twitter's Bootstrap, and other homebaked ingredients.

These instructions are mostly intended for akka committers who would like to update the site (i.e., adding a news item).

Dependencies

You'll need Jekyll installed. Please make sure that it is version 1.0.2 of Jekyll since that is what is used by GitHub. To get it, most people can install via RubyGems:

gem install jekyll

OSX users might have to update RubyGems:

sudo gem update --system

If in doubt, head over to the Jekyll wiki for installation instructions.

Building

After cloning, cd into the akka/akka.github.com directory and run:

jekyll serve --config _config_local.yml

To see the generated site, just visit http://localhost:4000.

Adding a News Item

News Items must be:

  1. written in Markdown
  2. named according to the following convention: YYYY-MM-dd-your-title.md, where of course YYYY is the 4-digit year, MM is the 2-digit month, and dd is the 2-digit day of the month.
  3. placed into the news/_posts/ directory
  4. contain YAML front matter

The YAML front matter for news items can come in one of three flavors.

For a standard news item that contains a significant body of text, the following YAML front matter will suffice:

---
layout: news
title: Your Title
author: Your Name
---

Write your news article here, and make sure it's in markdown!

In this case, the first 30 or so words will be taken from the body of the news item and displayed on the front page of akka.io.

However, if you'd like to override the text that's displayed, you could use the following YAML front matter:

---
layout: news
title: Your Title
author: Your Name
short: A short description should be written here. This is what's rendered on the front page.
---

Write your news article here, and make sure it's in markdown!

Here, whatever text is written in the short field of the front matter will be displayed on the front page of akka.io, underneath the title of the news item.

For a news item which points to another article outside of akka.io, the following YAML front matter will suffice:

---
layout: news
title: Your Title
author: Your Name

short: A short description should be written here. This is what's rendered on the front page.
link-out: http://link-to-whatever-site-has-the-article.com
---

In this case, the text in the short field will be what is displayed on the front page of akka.io. The URL in the link-out field will be what the title of the article links to on the front page of akka.io. There should be no body below the YAML front matter for these news articles.

Something went wrong with that request. Please try again.