en.javascript.info/README.md
Ilya Kantor 4f925a1983 Readme
2019-04-10 10:52:31 +03:00

35 lines
2.5 KiB
Markdown
Executable file
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Современный учебник Javascript
Всем привет!
Когда-то давно был только русский учебник https://learn.javascript.ru. Но несколько лет назад был полностью с нуля написан английский https://javascript.info. И с тех пор все существенные изменения вносились только в него.
Сейчас учебники уже довольно сильно разошлись. Между статьями есть общие фрагменты, но и много различий.
Самое лучшее, что можно сделать это перевести русский с английского. Для этого создан этот репозиторий.
Пожалуйста, переводите статьи и делайте PR.
Если взяли статью на перевод - имеет смысл сделать issue этоб этом, чтобы другие люди не переводили ее же.
# Структура
Каждому разделу, статье или задаче соответствует директория.
Эта директория имеет вид `N-url`, где `N` - это номер для сортировки статей и разделов (они упорядочены), а `url` URL-имя, по которому материал будет доступен.
В директории находится один из файлов:
- `index.md` для раздела
- `article.md` для статьи
- `task.md` для условия задачи (+там же `solution.md` с решением)
Каждый из этих файлов начинается с `# Заголовка материала`, и дальше текст в формате а-ля Markdown. Его довольно просто понять. Для редактирования достаточно простого текстового редактора.
Ресурсы и примеры, необходимые для статьи, раздела или задачи, находятся в её директории. На них можно ссылаться из материала.
# Запуск локально
Для удобства редактирования учебник можно запустить локально.
Сервер для этого находится здесь: <https://github.com/iliakan/javascript-tutorial-server>.