https://github.com/elixirschool/elixirschool

The content behind Elixir School
https://github.com/elixirschool/elixirschool

educational elixir elixir-lang hacktoberfest learning lesson programming translated-lessons translation

Last synced: about 1 month ago
JSON representation

The content behind Elixir School

• Host: GitHub
• URL: https://github.com/elixirschool/elixirschool
• Owner: elixirschool
• License: apache-2.0
• Created: 2015-05-31T18:27:42.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-09-24T07:52:32.000Z (about 2 months ago)
• Last Synced: 2024-09-26T23:41:49.877Z (about 1 month ago)
• Topics: educational, elixir, elixir-lang, hacktoberfest, learning, lesson, programming, translated-lessons, translation
• Homepage: https://elixirschool.com
• Size: 21.9 MB
• Stars: 3,530
• Watchers: 96
• Forks: 1,041
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• my-awesome-github-stars - elixirschool/elixirschool - The content behind Elixir School (Others)

README

        
# Elixir School

> Elixir School is the premier destination for people seeking to learn and master the Elixir programming language.

You can access lessons at [ElixirSchool.com](https://elixirschool.com).

_Feedback and participation are strongly encouraged! Please see [Contributing](CONTRIBUTING.md) for more details on how to get involved._

### Running Locally

This repository only contains the lessons and blog posts hosted on Elixir School. To run the Elixir School website locally, find the code and setup instructions in the [school_house](https://github.com/elixirschool/school_house) repository.

### Translating a Lesson

1. Each of the languages has a folder in `lessons/` directory of this repo. To start translating you need to copy a file from the English language to the corresponding folder in your language and start translating it.

2. Check the [translation report](https://elixirschool.com/pt/report/) for pages that haven't been translated yet, or for pages which need to have their translations updated in the corresponding language you want to work with.

3. Translated lessons must include page metadata.

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

   * `version` should be set to the original English `version`.

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

  ```yaml

  ---

  title: 基本

  version: 1.0.0

  ---

  ```

4. Submit a PR with the new translated lesson :tada:

### Posting an Article

Elixir School is powered by Phoenix and [NimblePublisher](https://github.com/dashbitco/nimble_publisher), a publishing engine that supports Markdown formatting. If you're familiar with Phoenix & NimblePublisher then you're ready to go, if you aren't don't fret we're here to help!

1. We need to create the file for our article. Blog posts live in the `posts/` directory. Our filename will need to confirm to the `YYYY-MM-DD-name-separated-with-hyphens.md` pattern.

2. After opening the new file in our favorite editor we need to add some metadata to the top of it:

```elixir

%{

  author: "Author Name",

  author_link: "https://github.com/author_github_account",

  tags: ["phoenix"],

  date: ~D[YYYY-MM-DD],

  title: "Full Article Title",

  excerpt: """

  Article short preview text

  """

}

---

```

3. Once we've completed writing our post submit a pull request to have it reviewed before it is published.