Elixir School

Elixir School is the premier destination for people seeking to learn and master the Elixir programming language.

You can access lessons at ElixirSchool.com.

Feedback and participation are strongly encouraged! Please see Contributing for more details on how to get involved.

Running locally

ElixirSchool.com is generated using Jekyll. To run it locally, you need both Ruby and Bundler installed.

1. Install dependencies:

$ bundle install

2. Run Jekyll:

$ bundle exec jekyll s

3. Access it at http://localhost:4000

Translating a lesson

1. Each of the languages has a folder in root of this repo. To start translating you need to copy a file from the English language to the corresponding folder in your language and start translating it.

2. Check the translation report for pages that haven't been translated yet, or for pages which need to have their translations updated in the corresponding language you want to work with.

3. Translated lessons must include page metadata.

   • title should be a translation of the original lesson's title.
   • version should be set to the original English version.

   For example /ja/lessons/basics/basics.md:

---
title: 基本
version: 1.0.0
---

4. Submit a PR with the new translated lesson and join https://elixirschool.com/contributors/.

Posting an article

In its current iteration Elixir School is powered by Jekyll, a powerful static blog generator. If you're familiar with Jekyll then you're ready to go, if you aren't don't fret we're here to help!

1. We need to create the file for our article. Blog posts live in the _posts/ directory. Our filename will need to confirm to the YYYY-MM-DD-name-separated-with-hyphens.md pattern.

2. After opening the new file in our favorite editor we need to add some metadata to the top of it:

---
author: Author Name
author_link: https://github.com/author_github_account (or website)
categories: article_category (find them or add a new one in _data/blog_meta.yml)
tags: ['phoenix'] (find them or create a new one in _data/blog_meta.yml)
date: YYYY-MM-DD for the post date
layout: post
title: Full Article Title
excerpt: >
 Article short preview text
---

3. Once we've completed writing our post we should add/update _data/contributors.yml with our details.