@htmlacademy/content-helper

Content-helper

Описание

Репозиторий хостится как npm пакет @htmlacademy/content-helper и экспортирует вспомогательные функции:

• buildRelease — функция для формирования контента из учебных репозиториев
• parseMdToHtml — функция которая переводит md в html формат. Внутри используются кастомные плагины, которые можно включать через настройки.

Настройки для деплоя учебного репозитория

• Если ещё не создан — создать package.json — npm init -y

• Установить зависимость:

npm i @htmlacademy/content-helper -DE

• В папке с репозиторием создать скрипт scripts/release.js, содержимым добавить:

"use strict";
const {buildRelease} = require("@htmlacademy/content-helper");

buildRelease({});

Посмотреть подробное описание аргументов, и значений по умолчание, которые принимает buildRelease можно по этой ссылке или в подсказках IDE при использовании функции

• в package.json добавить скрипты:

{
    "scripts": {
        "release": "node scripts/release.js",
        "start": "serve-intensive"
    }
}

Описание скриптов:

release — локально собирает папку с релизом

start — запускает локальный сервер для просмотра контента

• настроить (или попросить настроить) CI для деплоя содержимого релизной папки на сервер

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

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