Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 6.21 KB

README.ru.md

File metadata and controls

85 lines (54 loc) · 6.21 KB

English

IMP! (It's My Page! / Это моя страничка!)

Markdown для вас, HTML для читателей.

Одностраничная "CMS" на стороне клиента. На тот случай, когда нужно выложить пару нормально сверстанных страничек, ставить полноценную CMS не хочется, но хочется редактировать контент в GUI.

В отличие от других проектов такого типа, IMP! по умолчанию создает полностью статичные страницы, со всеми нужными SEO-тегами. Такая страница не требует Java Script для просмотра и может быть открыта в любом, в том числе, текстовом браузере.

Но если нужен интерактивный контент, IMP! позволяет добавлять произвольный HTML, CSS и JS, а также предоставляет API для создания более интегрированного интерактивного содержимого (примеры тут).

→ 📖 Документация

Как это работает

Когда IMP открывается локально, это браузерный редактор, позволяющий редактировать текст в markdown, добавлять стили и теги для SEO. Когда ту же страничку открывают по http, посетитель получает легкий статичный HTML. Демо тут.

Возможные применения

  • Цифровые эксперименты
  • Небольшие (служебные) сайты
  • Везде, где нужен "просто html".

Системные требования

Современный браузер, лучше Firefox или Chrome. Если вы обновляли браузер в течении последних 4-х лет, все должно работать.

Особенности

  • Работает без серверов, сервисов, не требует настройки. Нужен только браузер и локальный файл, работает на любой ОС
  • На выходе полностью статичный, легкий HTML, если вы сами не добавите скриптов.
  • Быстрый редактор markdown с точным предпросмотром и проверкой орфографии (используется функция браузера)
  • В текст можно включать любой HTML и добавлять скрипты.
  • Внедрение данных в страницу
  • API для внедрения любого контента (статичного и/или интерактивного)
  • Все можно кастомизировать .

Установка с использованием CDN в два клика

  1. Перейдите по ссылке
  2. Следуйте инструкциям (там все просто).

Такой вариант настройки не требует скачивания дополнительных файлов. Вы можете сразу открыть полученную страничку в браузере и начать редактировать (см. ниже), а потом закачать ее на свой сервер.

Установка всех файлов у себя

  1. Скачайте и распакуйте. В архиве лежат 4 файла, index.html, style.css, imp.js и helpers.js. Последний нужен только для интерактивного контента, см. полную документацию.
  2. Откройте файл index.html в браузере (Firefox или Chrome)
  3. Отредактируйте все, что нужно. В редакторе есть возможность импортировать готовый файл в markdown. Нажмите на большую кнопку "Export HTML" ("Save" в новых версиях) и сохраните файл в ту же директорию. Если вы не переименовывали файл, перезапишите старый.

Загрузите файлы на сервер, imp.js можно не загружать, он не нужен для просмотра.

Дизайн

В каждом файле есть поле для ввода дополнительного CSS, это удобно для небольших изменений и дополнений. Но можно полностью заменить файл style.css, в нем нет ничего особенного.

Больше файлов

Можно без проблем завести несколько файлов. Если они лежат в одной директории, то им нужен один файл imp.js.

Известные проблемы

  • Плохо сочетается с расширением NoScript, достаточно отключить NoScript для страницы. Именно отключить все ограничения, а не просто поставить режим TRUSTED!

Лицензии

  • MIT на все, кроме:
  • CC BY-CA - тема по-умолчанию на основе Gutenberg CSS

Создано благодаря великолепным проектам