Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
The akka.io site
HTML CSS JavaScript

Merge pull request #190 from akka/wip-stream-1.0-M5

Akka Streams & HTTP 1.0-M5
latest commit cfcac62ef6
@rkuhn rkuhn authored
Failed to load latest commit information.
_includes Release news for 2.2.5
_layouts Simpler download update
community add akka-persistence-android journal and snapshot
docs Akka Streams & HTTP 1.0-M5
downloads remove Activator video and include Akka templates and old versions
faq Akka 2.3.0 release
news Fix punctuation in 2.2.5 news
resources removed unneeded images
team Akka v2.3.2 release
.gitignore + akka-persistence-chronicle: new plugin contribution
404.html Release news for 2.2.5
CNAME Add CNAME file for akka.io
README.md Style updates - New Logo
_config.yml Change markdown renderer to kramdown from obsoleted maruku
_config_local.yml Change markdown renderer to kramdown from obsoleted maruku
akka-0.10.xsd add schema files in their old place
akka-1.0-M1.xsd add schema files in their old place
akka-1.0-RC1.xsd
akka-1.0-RC2.xsd
akka-1.0-RC3.xsd add schema files in their old place
akka-1.0-RC5.xsd
akka-1.0-RC6.xsd
akka-1.0.xsd
akka-1.1-M1.xsd
akka-1.1-RC1.xsd
akka-1.1.1.xsd
akka-1.1.2.xsd
akka-1.1.3.xsd
akka-1.1.xsd
akka-1.2-RC2.xsd
akka-1.2-RC3.xsd
akka-1.2-RC4.xsd
akka-1.2-RC5.xsd
akka-1.2-RC6.xsd
akka-1.2.xsd
akka-1.3-RC1.xsd
akka-1.3-RC2.xsd
akka-1.3-RC3.xsd
akka-1.3-RC4.xsd
akka-1.3-RC5.xsd
akka-1.3-RC6.xsd
akka-1.3-RC7.xsd
akka-1.3.1.xsd
akka-1.3.xsd
akka-2.0-M1.xsd
akka-2.0-M2.xsd
akka-2.0-M3.xsd
akka-2.0-M4.xsd
akka-2.0-RC1.xsd
akka-2.0-RC2.xsd
akka-2.0-RC3.xsd
akka-2.0-RC4.xsd
akka-2.0.xsd
akka.xsd add schema files in their old place
index.md pushing to github

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
gem install kramdown

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.

To watch for changes:

jekyll serve --watch --config _config_local.yml

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.