• Шаблоны для вашего сайта
  • Сделать сайт
  • Реклама
  • Berry CSS
  • Albireo Framework
  • Бесплатный HTML-курс
  • Telegram-канал
  • Обратная связь
MaxSite.org
О создании сайтов и не только
Создание сайтов под ключ (Украина) →
Вход
×
или зарегистрироваться

Albireo Doc и другие новости

Albireo FrameworkПросмотров: 2178Комментарии: 110 декабря 2020 г.

Расскажу об изменениях в проекте Albireo. (Вы также можете подписаться на мой телеграмм-канал, чтобы получать новости оперативно.) За последнее время, в Albireo было два важных изменения. Первое — доработка админ-панели. Я добавил кнопки для вставки кода в текстовый редактор (сделал на Alpine.js), а также ряд мелких правок, чтобы сделать панель более удобной.

Другое крупное изменение — работа кэша. Раньше он работал только по времени модификации файлов, но не учитывал изменения в структуре каталогов. Это могло приводить к тому, что кэш оказывался невалидным, если загрузить старые файлы или добавить/удалить каталоги. Это частая ситуация. Теперь кэш работает чуть по другому. Он создаёт «снимок» (snapshot) всего каталога, включая каждый файл и его дату модификации и получает числовой полином CRC32. Он сохраняется в отдельном файле. При повтором использовании, кэш сравнивает новое значение со старым и если были изменения, кэш считается невалидным.

Это позволяет отслеживать самые разные ситуации и изменения в каталоге данных. Я об этом рассказывал в телеграмм-канале и даже приводил цифры по нагрузочному тестированию.

Сегодня я выложил ещё одно дополнение, которое условно называется Albireo Doc — это готовое решение для тех разработчиков, которым нужен простой и удобный механизм для создания документации к своим проектам.

Строго говоря создание документации с помощью Albireo Framework, была основной идеей изначально. Но я не хотел её делать сходу, поскольку был ряд других важных задач. Но потихонечку я работал в этом направлении и теперь решил, что можно предложить готовый вариант.

Почему это важно?

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

Albireo Doc — это готовый для использования шаблон вывода (layout), который поддерживает боковое меню.

То есть страница документация — это самая обычная страница Albireo, только у неё указывается шаблон вывода и свой пункт меню.

...
layout: doc.php

menu[title]: Страницы документации
menu[group]: Основы
menu[order]: 2
...

Albireo сам найдёт параметры menu и на их основе сформирует группы и пункты меню.

Шаблон doc.php разделён на несколько файлов, чтобы можно было кастомизировать дизайн, ссылки, подвал, шапку, css-стили — то есть всё то, что может понадобиться индивидуально. Сам шаблон использует Berry CSS, но это единственная зависимость (нет даже внешнего js-кода).

В качестве дополнения используется сниппет для навигации next/prev — он может выводиться в любой части страницы.

Если проект предполагается выкладывать на GitHub, где не работает PHP, то можно сгенерировать статичные html-файлы. Это стандартная возможность Albireo.

Стоит ещё отметить, что меню можно сформировать и вручную (без параметра menu). Для этого предусмотрен второй вариант вывода — menu-manual.php, который работает с config/menu-data.php, где и хранятся все пункты и группы. Такой вариант удобен тем, что позволяет задавать пункты меню совершенно произвольно: ссылки могут вести на любую страницу сайта или за его пределы.

На сайте Albireo приведена вся информация (там тоже был редизайн) и ссылки на примеры. Думаю, что новые возможности фреймворка окажутся полезными и востребованными. :-)


Создание сайтов (Украина) →
Что такое API. Объяснение с примерами
Организация циклов в Alpine.js
twitter.com facebook.com
Другие записи сайта
Шаблон Decorator (Декоратор)
Шаблон Decorator (Декоратор)
MVC (Model View Controller) в JavaFX
MVC (Model View Controller) в JavaFX
Адаптивная сетка на flexbox
Адаптивная сетка на flexbox
Новости по моим проектам
Новости по моим проектам
Как я начал изучать Java и Android
Как я начал изучать Java и Android
Alpine.js - лёгкая альтернатива jQuery
Alpine.js - лёгкая альтернатива jQuery

Комментариев: 1 RSS

1Денис31-12-2020 16:15

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

Оставьте комментарий!

Комментарий будет опубликован после проверки. Вы соглашаетесь с правилами сайта.

(обязательно)

Навигация
  • Шаблоны для MaxSite CMS 22
  • jQuery и JavaScript 6
  • SQL 17
  • Java и Android 5
  • PHP/ООП 25
  • Albireo Framework 11
  • Berry CSS 7
  • CSS, HTML, LESS, SASS 23
  • PHP 37
  • Тайм-менеджмент 9
  • CodeIgniter 5
  • Landing Page 3
  • Софт 37
  • Alpine.js 14
  • SEO 13
  • Git. GitHub 3
  • Фильмы 2
  • Дневник 55

Здесь можно заказать создание сайта (только Украина), шаблона или лендинга. Также вы можете выбрать готовые шаблоны для MaxSite CMS по небольшой цене. Также можно купить отдельные модули, компоненты для вашего сайта.

MaxSite.org
Как создать свой сайт

Услуги по созданию сайтов, блогов, лендингов
Обратная связь • Реклама на сайте
Карта сайта
Мои проекты
  • Шаблоны для вашего сайта
  • Заказать создание сайта
  • MaxSite CMS
  • Berry CSS (CSS Utilities)
  • Albireo Framework
  • UniCSS (Universal Atomic CSS)
  • Landing Page Framework
  • Бесплатные НТML-курсы
Ссылки
  • Telegram-канал
  • Github
  • Twitter
  • Telegram-бот
  • RSS
© MaxSite.org, 2006-2022. Работает на MaxSite CMS | Время: 0.3387 | SQL: 20 | Память: 1.09MB | Вход