elixirschool/elixirschool

Name: elixirschool

Owner: Elixir School

Description: Lessons about the Elixir programming language

Created: 2015-05-31 18:27:42.0

Updated: 2018-01-18 17:08:53.0

Pushed: 2018-01-19 01:35:57.0

Homepage: https://elixirschool.com

Size: 6619

Language: CSS

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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:

   ndle install
   

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

   e: Elixir School
   ription: Lessons about the Elixir programming language
   url: /
    http://localhost:4000
   

3. Run Jekyll:

   ndle exec jekyll s
   

4. 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. ja, en, es, etc) with lesson subfolders:

    elixirschool
   dir -p ja/lessons/{basics,advanced,specifics,libraries}
   uch ja/lessons/{basics,advanced,specifics,libraries}/.gitignore
   

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

   uages: ['en', 'ja']
   ult_lang: en
   ude_from_localization: []
   ions:
   g: basics
   bel:
   en: Basics
   ja: ??
   
   ription:
   Lessons about the Elixir programming language
   ?????????Elixir?????
   
   
   Table of Contents
   ??
   

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

   languages: ['ar']
   

4. Add it to list in index.md:

   lable in [Vi?t ng?][vi], [??][cn], [Español][es], [Sloven?ina][sk], [???][ja], [Polski][pl] [Português][pt], [???????][ru] and [Bahasa Melayu][ms] and other.
   

Translated Lesson

1. Translated lessons must include the page metadata.

2. title should be a translation of the original lesson's title.

3. 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.

4. redirect_from should be removed since it is used only for English lessons that earlier were hosted in a separate folder without a language prefix.

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

   
   e: ??
   ion: 1.0.0