/javascript-tutorial

Учебник JavaScript

Primary LanguageHTML

Учебник JavaScript

Этот репозитарий содержит учебник JavaScript https://learn.javascript.ru.

Движок, написанный на io.js, находится в отдельном репозитарии https://github.com/iliakan/javascript-nodejs, а здесь — текст.

Делать исправления и предлагать PR по коду нужно там, по тексту учебника — здесь.

Структура

Каждому разделу, статье или задаче соответствует директория.

Эта директория имеет вид N-url, где N - это номер для сортировки статей и разделов (они упорядочены), а url — URL-имя, по которому материал будет доступен.

В директории находится один из файлов:

  • index.md для раздела
  • article.md для статьи
  • task.md для условия задачи (+там же solution.md с решением)

Каждый из этих файлов начинается с # Заголовка материала.

Абсолютный URL для разделов и статей -- это URL-имя без номера и родителей, для задачи -- с префиксом /task/.

Например:

  • директория 2-ui/3-event-details с файлом index.md - это раздел сайта "События в деталях", он будет доступен по URL /event-details.
  • директория 2-ui/3-event-details/6-drag-and-drop с файлом article.md содержит статью "Мышь: Drag'n'Drop, доступную по URL /drag-and-drop`.
  • директория 2-ui/3-event-details/6-drag-and-drop/slider с файлом task.md содержит задачу с названием "Слайдер", доступную по адресу /task/slider.
Заметим, что хотя структура директорий вложенная — URL-адреса "плоские". То есть, для URL берётся только название самой глубокой директории, без родителей: https://learn.javascript.ru/event-details, https://learn.javascript.ru/drag-and-drop и т.п. Это сделано специально, чтобы удобно было упорядочивать учебник, переносить статьи без изменения URL.

Ресурсы и примеры, необходимые для статьи, раздела или задачи, находятся в её директории. На них можно ссылаться из материала.

Все исправления и замечания, оформленные в виде Pull Request, будут учтены.