Lessons about the Elixir programming language
CSS HTML JavaScript Ruby
Latest commit 0e95798 Jan 23, 2017 @Suckzoo Suckzoo committed with devleoper [KO] Improve Comprehension lesson (#935)
* Change some Korean terms back to original not to confuse the meaning.

* Some other suggestion for readability.

* Replace the changed term(comprehensions) in other lessons.
Permalink
Failed to load latest commit information.
_assets Stylesheets for Printers. (#520) Jul 16, 2016
_includes Add the new section for libraries (#729) Nov 28, 2016
_layouts Changed meta descriptions and og:url to show proper information. (#517) Jul 16, 2016
_sass Setup Jekyll on Heroku Nov 26, 2015
assets Dialyzer debugger lesson (#900) Jan 16, 2017
bg Use singular for types in comparison description (#928) Jan 19, 2017
bn
cn [CN] Fix a typo in the `basics/control-structures` lesson (#903) Jan 16, 2017
de Use singular for types in comparison description (#928) Jan 19, 2017
es Use singular for types in comparison description (#928) Jan 19, 2017
fr Use singular for types in comparison description (#928) Jan 19, 2017
gr [GR] Update plug.md (#933) Jan 20, 2017
id
it Use singular for types in comparison description (#928) Jan 19, 2017
jp Use singular for types in comparison description (#928) Jan 19, 2017
ko [KO] Improve Comprehension lesson (#935) Jan 23, 2017
lessons Use singular for types in comparison description (#928) Jan 19, 2017
my
no
pl Use singular for types in comparison description (#928) Jan 19, 2017
pt Use singular for types in comparison description (#928) Jan 19, 2017
ru Use singular for types in comparison description (#928) Jan 19, 2017
sk Use singular for types in comparison description (#928) Jan 19, 2017
tr Use singular for types in comparison description (#928) Jan 19, 2017
uk Use singular for types in comparison description (#928) Jan 19, 2017
vi Translate to vietnamese (#918) Jan 23, 2017
.gitignore
CONTRIBUTING.md link to style guide in CONTRIBUTING.md (#829) Nov 28, 2016
GLOSSARY.md [RU] Add the 'libraries/poolboy' lesson translation (#892) Jan 5, 2017
Gemfile Fix Ruby version Oct 19, 2016
Gemfile.lock
LICENSE
Procfile
README.md Update license image URL (#888) Dec 19, 2016
Rakefile Setup Jekyll on Heroku Nov 26, 2015
_config.yml Translate to vietnamese (#918) Jan 23, 2017
app.json Add Heroku app.json (#267) Apr 7, 2016
config.ru Setup Jekyll on Heroku Nov 26, 2015
index.md Added BN locale link (#881) Dec 22, 2016
robots.txt Add Sitemap.xml and Robots.txt Mar 16, 2016

README.md

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,libraries}
    $ touch jp/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:

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