Website for Elixir
CSS HTML Elixir JavaScript Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data Release v1.6.4 Mar 16, 2018
_epub Update generated epubs Feb 9, 2018
_includes Remove Try Elixir learning resource links (#1110) Mar 31, 2018
_layouts Remove Try Elixir learning resource links (#1110) Mar 31, 2018
_posts Improve an example in the StreamData blog post Mar 16, 2018
blog Fix broken internal links Feb 28, 2015
css Remove Try Elixir learning resource links (#1110) Mar 31, 2018
getting-started Fixes small typo (#1114) Apr 9, 2018
images Push missing epub file Feb 9, 2018
js fix toc.js to escape special characters in href Mar 3, 2015
.gitignore Ignore .jekyll-metadata (#933) Jan 23, 2017
Gemfile Remove warnings when running jekyll, closes #1035 Sep 24, 2017
Gemfile.lock Remove warnings when running jekyll, closes #1035 Sep 24, 2017
README.md Add link to Apache Lincese in README.md May 8, 2017
_config.yml Specify canonical URL for the website (#1072) Jan 10, 2018
atom.xml move back to original folder Feb 5, 2015
crash-course.markdown Remove dead link to Erlang cookbook (#1096) Feb 28, 2018
development.markdown Link to the compatibility and deprecation document Mar 26, 2018
docs.markdown Use proper heading in docs.html Jul 30, 2017
elixir.csv Release v1.6.4 Mar 16, 2018
erlang.csv Update Erlang and Elixir versions Dec 19, 2017
favicon.ico move back to original folder Feb 5, 2015
index.html Add a section about language development (#1052) Oct 22, 2017
install.markdown Last Raspbian release and https protocol (#1082) Jan 26, 2018
learning.markdown Remove Try Elixir learning resource links (#1110) Mar 31, 2018
opensearch.xml Add OpenSearch support Jul 27, 2015

README.md

This projects holds the contents for Elixir website hosted at elixir-lang.org.

It is automatically transformed by Jekyll into a static site.

Contributing

1. Fork and clone this repository

Fork this repository and clone your fork. If you don't know what forking means or don't know how to do it, nice instructions are available here.

2. Install Ruby

This website is compiled into a static website using Jekyll, a static-site generator written in Ruby. To install Ruby you can follow this guide. To check that Ruby is installed correctly, run ruby --version in your shell; it should be 1.9.3 or later.

3. Install Bundler to manage dependencies

Bundler handles Ruby dependencies. To install it, simply run:

$ gem install bundler

Once you have installed it, cd into the local clone of your fork and run:

$ bundle install

to download and install the necessary dependencies.

4. Run Jekyll

In order to run a development server (with live-reloading on) just run:

$ bundle exec jekyll serve

The generated site will be available at http://localhost:4000. You can stop the server with Ctrl-C.

5. Make your changes and push them

Now you're ready to make your changes! Be sure to test the changes locally using the development server. Once you're done with your changes, push those changes to your fork and then submit a pull request. For a nice wrap-up on how to open a good pull request have a look at the Elixir contributing guide.

License

  • "Elixir" and the Elixir logo are copyrighted to Plataformatec. You may not reuse anything therein without permission.

  • The HTML and CSS are copyrighted to AlienWp under GPL license, version 2.

  • The Social Icons are copyrighted to Xeloader.

  • The written textual contents available in the guides and blog are licensed under Apache License, Version 2.0.

  • The available docs are licensed under the same license as their projects.