|
1 | 1 |
|
2 | | -# Учебник JavaScript |
| 2 | +# The JavaScript Tutorial |
3 | 3 |
|
4 | | -Этот репозитарий содержит учебник JavaScript [https://learn.javascript.ru](https://learn.javascript.ru). |
| 4 | +This repository hosts the content of the JavaScript Tutorial, to be available on [https://javascript.info](https://javascript.info). |
5 | 5 |
|
6 | | -Движок, написанный на io.js, находится в отдельном репозитарии https://github.com/iliakan/javascript-nodejs, а здесь — текст. |
| 6 | +The backend is written using [io.js](https://iojs.org/en/index.html). It is in the separate repo: [https://github.com/iliakan/javascript-nodejs](https://github.com/iliakan/javascript-nodejs), here is the text only. |
7 | 7 |
|
8 | | -Делать исправления и предлагать PR по коду нужно там, по тексту учебника — здесь. |
| 8 | +Please use this repository to file issues and suggest PRs for the text. |
9 | 9 |
|
10 | | -## Структура |
| 10 | +## Structure |
11 | 11 |
|
12 | | -Каждому разделу, статье или задаче соответствует директория. |
| 12 | +Every chapter, article or task has it's folder. |
13 | 13 |
|
14 | | -Эта директория имеет вид `N-url`, где `N` - это номер для сортировки статей и разделов (они упорядочены), а `url` — URL-имя, по которому материал будет доступен. |
| 14 | +The folder has the name `N-url`, where `N` is a number for the sorting and `url` — is the URL-address for the material. |
15 | 15 |
|
16 | | -В директории находится один из файлов: |
| 16 | +The kind of the material is defined by the file inside the folder: |
17 | 17 |
|
18 | | - - `index.md` для раздела |
19 | | - - `article.md` для статьи |
20 | | - - `task.md` для условия задачи (+там же `solution.md` с решением) |
| 18 | + - `index.md` means a chapter |
| 19 | + - `article.md` means an article |
| 20 | + - `task.md` means a task (+must also have `solution.md` with the solution) |
21 | 21 |
|
22 | | -Каждый из этих файлов начинается с `# Заголовка материала`. |
| 22 | +Each of these files starts from the `# Main header`. |
23 | 23 |
|
24 | | -Абсолютный URL для разделов и статей -- это URL-имя без номера и родителей, для задачи -- с префиксом `/task/`. |
| 24 | +Assets required for the material are in it's folder and can be referenced from the file. |
25 | 25 |
|
26 | | -Например: |
27 | | - |
28 | | - - директория `2-ui/3-event-details` с файлом `index.md` - это раздел сайта "События в деталях", он будет доступен по URL `/event-details`. |
29 | | - - директория `2-ui/3-event-details/6-drag-and-drop` с файлом `article.md` содержит статью "Мышь: Drag'n'Drop`, доступную по URL `/drag-and-drop`. |
30 | | - - директория `2-ui/3-event-details/6-drag-and-drop/slider` с файлом `task.md` содержит задачу с названием "Слайдер", доступную по адресу `/task/slider`. |
31 | | - |
32 | | -<blockquote> |
33 | | -Заметим, что хотя структура директорий вложенная — URL-адреса "плоские". То есть, для URL берётся только название самой глубокой директории, без родителей: https://learn.javascript.ru/event-details, https://learn.javascript.ru/drag-and-drop и т.п. Это сделано специально, чтобы удобно было упорядочивать учебник, переносить статьи без изменения URL. |
34 | | -</blockquote> |
35 | | - |
36 | | -Ресурсы и примеры, необходимые для статьи, раздела или задачи, находятся в её директории. На них можно ссылаться из материала. |
37 | | - |
38 | | -Все исправления и замечания, оформленные в виде Pull Request, будут учтены. |
| 26 | +For example, an `image.png` for the article should be in it's folder and accessed as `<img src="image.png">` from it's `article.md` file. |
0 commit comments