eleontev / learn

Справочные материалы WebPurple

WebPurple Learn Book

Локальная работа

git clone https://github.com/WebPurple/learn.git
cd learn
npm install
npm start

Структура

Непосредственно файлы со справочным материалом должны размещаться в директории book.
Они могут быть распределены по вложенным директориями на любом уровне.
В файле book/SUMMARY.md задаётся структура разделов и подразделов.

* [Имя раздела](Файл с описанием раздела)
    * [Имя подраздела](Файл с описанием подраздела)
        * [Имя подраздела 2-го уровня](Файл с описанием подраздела 2-го уровня)
    * [Имя подраздела](Файл с описанием подраздела)
    * [Имя подраздела](Файл с описанием подраздела)

Пример описания раздела и подраздела:

* [Лекция 1](lecture1/README.md)
    * [Что такое JS](lecture1/what-is-js.md)
    * [История JS](lecture1/js-history.md)

Создание записей

Markdown

Для форматирования текста используется стандартный Markdown, более подробную информацию можно найти в "Markdown Cheatsheet".

HTML

В Markdown можно встраивать html, в том числе и с JavaScript-кодом.

# Header 1
[link](url)
<span onclick="alert()">Test</span>
**bold**

Картинки

При встраивании в страницу изображения лучше "положить" файл изображения в book/images, после чего в md-файле вставить картинку.

![Alt text](images/path/to/img.png)

Якоря

Каждый заголовок на странице является якорем. В md-файле описываем заголовок.

# Lecture 1

После чего можем переходить непосредственно к нему: http://url-to-page/#lecture-1.

"Include" файлов

В случае необходимости переиспользования контента одного файла в другом файле можно использовать следующий синтаксис.

!INCLUDE "path/to/file.md"

Тэги

Для указания тэгов страницы необходимо в самом верху файла описать эти тэги.

tags: tag1, tag2, tag3

Для увеличения производительности генерация страницы тэгов происходит только при первом запуске GitBook, для обновления этой страницы в режиме "разработки" необходимо перезапустить npm start.

Exercises

Для описания практических заданий используется плагин "Exercises".

{% exercise %}
Присвойте переменной `x` значение 10.

{% initial %}
var x =

{% solution %}
var x = 10;

{% validation %}
assert(x == 10);

{% context %}
// Описание контекста задания
// Описанные здесь переменные и функции будут доступны пользователю
var exposedVar = 3;
function exposedFunction {
    return 3;
}
{% endexercise %}