renovations

This commit is contained in:
Ilya Kantor 2015-01-14 12:13:04 +03:00
parent e1948130f6
commit b76c541212
5 changed files with 106 additions and 65 deletions

33
README.md Executable file
View file

@ -0,0 +1,33 @@
# Учебник JavaScript
Этот репозитарий содержит учебник JavaScript, включая все разделы, статьи, задачи.
Он предназначен для отображения движком сайта javascript.ru, репозитарий https://github.com/iliakan/javascript-nodejs.
При этом синтаксис намеренно сделан совместимым с GitHub, чтобы при желании можно было читать текст прямо из репозитария. Конечно, "живые" примеры и другие продвинутые возможности при этом будут не доступны, т.к. парсер GitHub их не умеет.
**Каждому разделу, статье или задаче соответствует директория.**
Эта директория имеет вид `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`.
Ресурсы и примеры, необходимые для статьи, раздела или задачи, находятся в её директории. На них можно ссылаться из материала.