Иногда стандартного предпросмотра маркдауна недостаточно, и нужно посмотреть на статью в оформлении сайта.
Мы сделали такой предпросмотр удобным с помощью Docker. Для этого необходимо выполнить следующие команды:
- Установите
- на компьютер Windows или Mac: Docker Desktop;
- на Ubuntu Linux: Docker Engine;
- на других Lunux-дистрибутивах не тестировалось, но найти их можно на сайте Docker;
- на всех Linux-дистрибутивах, чтобы Docker не требовал прав супер-пользователя, его необходимо добавить в группу с правами после установки (инструкция).
- Откройте консоль и перейдите в папку с этого репозитория.
- Выполните команду
./start.sh
на Mac или Linux, либоbash -c "./start.sh"
на Windows. - Следуйте инструкциям
- Дождитесь, когда в консоли появится заголовок
Access URLs
. - Перейдите по адресу http://localhost:8080 на вашу локальную копию сайта.
Есть и другой способ без Docker. Для этого вам необходимо собрать сайт локально:
- Стягиваете себе репозиторий с контентом.
- Проверьте, что у вас установлены Node.js и NPM. Это можно сделать командами
npm -v
иnode -v
. Если получаете корректный ответ с версией, всё установлено. Когда нет, мы рекомендуем актуальную LTS-версию. - Клонируете репозиторий с платформой. Папка с платформой и папка с контентом должны лежать рядом.
📁 родительская папка
|
|- 📁 content
|- 📁 platform
- В папке с платформой дублируете файл
.env.example
и переименовываете копию в.env
. Если у папки с контентом другое имя, не content, не забудьте изменить значение параметраPATH_TO_CONTENT
в файле.env
. - Устанавливаете зависимости командой
npm i
. - Запускаете сборку командой
npm start
.
Больше информации о локальной сборке в репозитории платформы.
🧨 Вы можете редактировать статью и видеть все изменения вживую — достаточно не закрывать терминал, в котором запущена сборка. Для коммитов откройте новую вкладку терминала, в котором нужно зайти в папку с контентом. Останавливать и запускать сборку платформы после каждого изменения в контенте не нужно. Все изменения подтянутся автоматически.
Чтобы выключить локальную копию сайта, нажмите Ctrl C в консоли, где работает сборка платформы.