Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 2.48 KB

README.md

File metadata and controls

72 lines (48 loc) · 2.48 KB
Raw

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

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