Интерактивная документация по алгоритмам

Идея проекта: создать легкую для понимания документацию по алгоритмам.

Требования

Необходимо использовать Node версии 12 или выше.

• Node
• NVM (опционально)

Посмотреть версию Node можно командой:

node --version

Установка проекта

Для установки следуйте приведенным ниже инструкциям:

1. Склонируйте репозиторий в текущую папку:

git clone https://github.com/physcodestyle/algo-doc

2. Установите необходимые модули и выполните начальную команду сборки:

cd algo-doc
npm install
npm run build (необходимо только для первого раза сборки!)

3. Запустите свой локальный сервер, чтобы увидеть сайт по адресу http://localhost:8080:

npm run start

Дизайн

При построении дизайн-системы учитываются следующие условия:

1. Интерфейс должен быть доступным (требования).
2. Мотивация знакомства с материалами ресурса через дизайн.
3. Поддержка широкого класса устройств (разрешения и ориентация экранов, плотность пикселей).
4. Минимализм.
5. Поддержка темной и светлой темы.

Дизайн-система доступна для ознакомления и работы по ссылке.