dyhpoon / elixir-school

Lessons about the Elixir programming language

Elixir School

Lessons about the Elixir programming language, inspired by Twitter's Scala School.

Lessons can now be viewed on ElixirSchool.com.

Feedback and participation is welcome. Please see Contributing for more details on how to get involved.

Running

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

1. Install dependencies:

   $ bundle install

2. Update url in _config.yml to match your machine:

title: Elixir School
description: Lessons about the Elixir programming language
baseurl: /
url: http://localhost:4000

1. Run Jekyll:

   $ bundle exec jekyll s

2. Read it at http://localhost:4000

Translating

In addition to the steps above there are a few addition steps required for translation.

New Language

1. Create a folder using the 2 character code (e.g. jp, en, es, etc) with lesson subfolders:

$ cd elixir-school
$ mkdir -p jp/lessons/{basics,advanced,specifics,libraries}
$ touch jp/lessons/{basics,advanced,specifics,libraries}/.gitignore

1. Update _config.yml by including the 2 character code in languages and adding translations to sections, description and toc:

languages: ['en', 'jp']
default_lang: en
exclude_from_localization: []
sections:
  - tag: basics
    label:
      en: Basics
      jp: 基本

description:
  en: Lessons about the Elixir programming language
  jp: プログラミング言語Elixirのレッスン

toc:
  en: Table of Contents
  jp: 目次

1. If the new language is RTL (right-to-left) it should also be added to the rtl_languages list:

rtl_languages: ['ar']

1. Add it to list in index.md:

Available in [Việt ngữ][vi], [汉语][cn], [Español][es], [Slovenčina][sk], [日本語][jp], [Polski][pl] [Português][pt], [Русском][ru] and [Bahasa Melayu][my] and other.

Translated Lesson

1. Translated lessons must include the page metadata.

   • layout, category and order should be copied from the original lesson.
   • lang should be a 2 character code previously selected on the folder creation step.
   • title should be a translation of the original lesson's title.
   • version should consist of three digits: major.minor.patch, so:
     • if this is a initial lesson translation, the version should be set to 1.0.0;
     • if you apply the original lesson updates to the translation, the version should be copied from the corresponding state of the original lesson;
     • else bump one of the version numbers depending on how important is your change.

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

---
layout: page
title: 基本
category: basics
order: 1
lang: jp
version: 1.0.0
---