gantry5

Портальная структура

Готовы начать работу с Gantry 5? Замечательно! Мы здесь, чтобы помочь.

На этой странице вы найдете несколько быстрых советов, которые помогут вам приступить к работе с Gantry 5. Более подробную документацию по каждому из этих советов можно найти, нажав кнопку «Подробнее» в нижней части каждого раздела.

Мы надеемся, что Gantry 5 вам понравится так же, как нам понравилось его создавать.

Требования к браузеру

Требования к внутреннему администрированию Gantry в порядке предпочтения следующие:

• Гугл Хром 60+
• Фаерфокс 60+
• Сафари 12+
• Опера 47+
• MS Край

Примечание. Internet Explorer больше не поддерживается.

Установка Gantry 5 и темы Hydrogen

Gantry 5 — это фреймворк, с помощью которого создаются темы на базе Gantry. Чтобы тема Gantry работала, вам необходимо установить как фреймворк , так и тему . Сделать это совсем не сложно.

Первое, что вам нужно сделать, это загрузить последнюю версию Gantry 5 и Hydrogen. Вы можете сделать это, щелкнув ссылки ниже или через GitHub.

Скачать стабильную версию	Загрузить сборки CI

Если у вас есть последние версии пакетов, установка проста. Мы предоставили пошаговое руководство в разделе «Установка» этой документации.

Узнать больше

Доступ к администратору Gantry

Джумла

После того как вы установили и активировали как платформу Gantry, так и Hydrogen, вы можете получить доступ к администратору Gantry 5 несколькими различными способами. Самый простой способ — просто перейти в раздел «Компоненты» > «Шаблоны Gantry 5» из серверной части Joomla.

Здесь вы увидите список всех установленных тем на базе Gantry. Вы можете просмотреть тему здесь или выбрать «Настроить», чтобы перейти непосредственно к администратору Gantry , где вы сможете начать изменять свой сайт на базе Gantry.

Навигация по администратору Gantry 5

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

В администраторе Gantry 5 вы заметите следующие пункты меню:

1. Редактор меню : эта административная панель дает вам возможность улучшать меню платформы, изменяя стиль, переупорядочивая ссылки и создавая элементы меню, которые находятся за пределами встроенного менеджера меню CMS.

2. О программе : на этой странице вы найдете краткую информацию о текущей теме. Это универсальный магазин для получения информации о теме, включая: название, номер версии, создателя, ссылки на поддержку, функции и многое другое.

3. Настройки платформы : эта кнопка позволяет перейти на страницу настроек CMS для Gantry 5. В Joomla это страница конфигурации разрешений .

4. Очистить кэш : эта кнопка очищает файлы кэша, относящиеся к Gantry. Сюда входят все временные файлы за пределами CSS и информация о конфигурации.

5. Раскрывающийся список «Контуры» . Этот раскрывающийся список позволяет легко переключаться между контурами, не выходя из администратора Gantry.

6. Стили : эта административная панель предоставляет вам доступ к настройкам структуры, связанным со стилями. Сюда входят такие вещи, как цвета темы, шрифты, предустановки стилей и многое другое.

7. Настройки : эта административная панель предлагает вам возможность настраивать функциональные параметры темы. Сюда входит установка значений по умолчанию для частиц, а также включение/отключение отдельных частиц.

8. Макет : в этой административной панели вы можете настроить макет вашей темы. На этой панели выполняется создание позиций модуля размещения, частиц, разделителей и неотрисованных скриптов, таких как код Google Analytics.

Узнать больше

Что такое контуры, частицы, атомы и т. д.?

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

Срок	Определение
Контур	Настраиваемый стиль, используемый в одной или нескольких областях вашего сайта. Он служит контейнером, в котором задаются стиль, настройки и макет страницы.
Частица	Обычно небольшой блок данных, используемый во внешнем интерфейсе. Он во многом похож на виджет/модуль, но его можно легко настроить в администраторе Gantry 5.
Атом	Тип частиц, который содержит необработанные данные, например пользовательские сценарии (JS, CSS и т. д.) или аналитические сценарии для отслеживания трафика.

Узнать больше

Где получить помощь

С помощью Gitter был создан чат, куда вы можете поговорить о проекте с разработчиками, участниками и другими членами сообщества. Это лучшее место, где можно получить быстрые советы и обсудить функции с другими.

Документация также доступна и постоянно дополняется по мере развития. Чего-то не хватает? Вы можете внести свой вклад в документацию через GitHub.

Как внести свой вклад

Вносить вклад в платформу Gantry 5 или в связанную с ней документацию очень легко. Разработка обоих этих проектов ведется через Github, где вы можете отправлять Проблемы , чтобы сообщать о любых ошибках или предлагать улучшения, а также отправлять свои собственные запросы на включение , чтобы отправлять свои собственные исправления и дополнения.

Мы рекомендуем пообщаться с командой через Gitter перед отправкой запроса на включение, чтобы не дублировать исправление, которое уже находится на рассмотрении или которое может быть перезаписано предстоящим изменением.

Использование git-версии Gantry

Чтобы использовать git-версию Gantry, сначала необходимо установить зависимости композитора. Для этого запустите:

 bin/composer-install

После этого вам необходимо правильно связать Gantry с символической ссылкой на вашу установку CMS.

Объединение JS и компиляция SCSS

В нашей среде разработки мы используем Gulp для объединения JavaScript и компиляции SCSS с возможностью watch , чтобы любое изменение в целевых файлах автоматически запускало перекомпиляцию.

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

Обратите внимание: чтобы это работало, вам нужен исходный код Gantry 5 , а не пакет. Вы можете клонировать его или загрузить исходный код с GitHub.

Первое, что вам понадобится — это Node / NPM . Если у вас их еще нет, вы можете загрузить установщик для своей ОС по адресу https://nodejs.org/download/.

Следующим шагом будет установка всех зависимостей модуля JS. Для этого убедитесь, что вы находитесь в корне проекта Gantry 5, и выполните команду npm install .

Как только это будет сделано, вы можете установить Gulp . Мы рекомендуем устанавливать Gulp глобально, чтобы вы могли использовать команду из любой папки. Вот команда для этого: sudo npm install gulp --global

Gantry имеет разные наборы файлов JS и CSS, которые можно перекомпилировать из корня. При первом запуске Gantry или если вам когда-нибудь понадобится сбросить и переустановить все модули, вы можете запустить команду npm run build-assets . Эта операция удалит все папки node_modules и повторно запустит npm install во всех папках проекта. Это займет некоторое время.

Альтернативный метод, который не удалит все папки node_modules , — это gulp -up .

Наряду с командой -up вы также можете использовать -update , --update , -up , --up , -install , --install , -inst , --inst , -go , --go , -deps , --deps . Тот, который вам легче запомнить. Код сам поймет, нужно ли ему устанавливать первый раз или просто обновить модули узла.

Обратите внимание, что это может занять несколько минут.

На данный момент у вас есть все необходимое для запуска Gulp. Просто введите команду gulp , и вы увидите, как CSS и JS компилируются.

Также мы предлагаем несколько полезных задач:

1. $ gulp / $ gulp all : компилирует весь CSS и JS в проекте.
2. $ gulp watch : запускает компиляторы в режиме watch . Любое изменение, примененное к целевым файлам JS или SCSS, приведет к автоматической перекомпиляции.
3. $ gulp watch --css / $ gulp watch --js : запускает компиляторы в режиме watch и прослушивает только изменения SCSS или JS . Полезно, если вы сосредотачиваетесь только на одном, а не на другом.
4. $ gulp css / $ gulp js : компилирует все файлы CSS или JS, если вы работаете только с одним, а не с другим.
5. $ gulp —prod : компилирует все CSS и JS в рабочем режиме. Скомпилированные файлы не будут иметь исходных карт и будут сжаты (обычно это занимает немного больше времени, чем в обычном режиме).

Обновление Google Шрифтов

Файл JSON Google Fonts можно создать, следуя руководству по адресу https://developers.google.com/fonts/docs/developer_api или просто используя https://www.googleapis.com/webfonts/v1/webfonts?key=YOUR-API-KEY -URL-адрес https://www.googleapis.com/webfonts/v1/webfonts?key=YOUR-API-KEY . Вам необходимо включить использование Google Fonts API и предоставить свой ключ API вместо YOUR-API-KEY .

Лицензия

Gantry Framework v5 или новее лицензируется по системе двойной лицензии (MIT или GPL версии 2 или новее). Это означает, что вы можете свободно выбирать, какая лицензия (MIT или GPL версии 2 или новее) соответствует вашим потребностям.

Подробнее