elixir-school 0,2,4,1,2,0

Lessons about the Elixir programming language

Elixir School License

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
  3. Run Jekyll:

    $ bundle 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. jp, en, es, etc) with lesson subfolders:

    $ cd elixir_school
    $ mkdir -p jp/lessons/{basics,advanced,specifics}
    $ touch jp/lessons/{basics,advanced,specifics}/.gitignore
  2. 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: 目次
  3. If the new language is RTL (right-to-left) it should also be added to the rtl_languages list:

    rtl_languages: ['ar']
  4. 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 lang: XX in the page meta data. For example /jp/lessons/basics/basics.md:

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

Related Repositories

computer-science

computer-science

:mortar_board: Path to a free self-taught education in Computer Science! ...

awesome-opensource-documents

awesome-opensource-documents

:blue_book: A curated list of awesome open source or open source licensed docume ...

elixirconf-2016

elixirconf-2016

ElixirConf 2016 summary ...

elixir-companies

elixir-companies

A list of companies currently using Elixir in production. ...

ElixirBooks

ElixirBooks

List of Elixir books ...


Top Contributors

doomspork nscyclone brain-geek Koziolek pjhampton pragmaticivan hinamiyagk michalvalasek rezaprima 3100 devleoper milmazz joneslee85 apeacox Dalgona gemantzu malkoG erickgnavar jinyeow riseshia scouten marocchino julienXX cizixs Devalo therobinsj vnnoder kdebowski yyyc514 kianmeng