grapesjs README

The project's README from github.com/GrapesJS/grapesjs. As one markdown file: README.md.

GrapesJS

Build Status Chat CDNJS npm

If you looking to embed the Studio editor in your application, we now offer the Studio SDK, a ready-to-use visual builder that's easy to embed in external applications, with GrapesJS team support included.

GrapesJS

GrapesJS is a free and open source Web Builder Framework which helps building HTML templates, faster and easily, to be delivered in sites, newsletters or mobile apps. Mainly, GrapesJS was designed to be used inside a CMS to speed up the creation of dynamic templates. To better understand this concept check the image below


GrapesJS - Style Manager


Generally any 'template system', that you'd find in various applications like CMS, is composed by the structure (HTML), style (CSS) and variables, which are then replaced with other templates and contents on server-side and rendered on client.

This demos show examples of what is possible to achieve:
Webpage Demo - http://grapesjs.com/demo.html
Newsletter Demo - http://grapesjs.com/demo-newsletter-editor.html

Table of contents

Features

Blocks Style Manager Layer Manager
GrapesJS - Block Manager GrapesJS - Style Manager GrapesJS - Layer Manager
Code Viewer Asset Manager
GrapesJS - Code Viewer GrapesJS - Asset Manager

Download

For the development purpose you should follow instructions below.

Usage

<link rel="stylesheet" href="path/to/grapes.min.css" />
<script src="path/to/grapes.min.js"></script>

<div id="gjs"></div>

<script type="text/javascript">
  var editor = grapesjs.init({
    container: '#gjs',
    components: '<div class="txt-red">Hello world!</div>',
    style: '.txt-red{color: red}',
  });
</script>

For a more practical example I'd suggest looking up the code inside this demo: http://grapesjs.com/demo.html

Development

Follow the Contributing Guide.

Documentation

Check the getting started guide here: Documentation

API

API References could be found here: API-Reference

Testing

$ pnpm test

Plugins

Official Plugins | Community Plugins

Wrappers

Extensions

Presets

Find out more about plugins here: Creating plugins

Support

If you like the project and you wish to see it grow, please consider supporting us with a donation of your choice or become a backer/sponsor via Open Collective

PayPalMe Bitcoin


BrowserStack
Thanks to BrowserStack for providing us browser testing services

License

BSD 3-clause

grapesjs (GrapesJS/grapesjs)

Searching Database…

26.3K ·GitHub
Grapesjs
Что это такое?GrapesJS — это бесплатный фреймворк с открытым исходным кодом для создания HTML-шаблонов без программирования: визуальный конструктор сайтов. Готовые шаблоны можно использовать на сайтах, в рассылках или в мобильных приложениях.
Это онлайн-конструктор сайтов, куда нужно регистрироваться, или код, который встраиваешь сам?Это фреймворк, а не готовый онлайн-сервис: вы встраиваете визуальный редактор в своё JavaScript-приложение — чаще всего в CMS — чтобы ускорить создание динамических шаблонов.
Как добавить его в проект?Установить через npm (npm i grapesjs), подключить с CDN вроде UNPKG или CDNJS либо клонировать git-репозиторий. В документации есть руководство для начала работы.
Нужно ли что-то устанавливать, чтобы он работал?Ничего особенного: это клиентская библиотека на TypeScript, подключаемая через npm или CDN. Для работы над самим репозиторием нужны Node 20+ и pnpm 9+.
Смогу ли я собирать шаблоны, если я не разработчик?Да — конечные пользователи собирают страницы визуально, перетаскивая блоки на холст, без программирования. Писать код нужно только чтобы встроить редактор в приложение и настроить его.
Он правда бесплатный, и можно ли использовать его в коммерческих проектах?Да — он бесплатный и распространяется с открытым исходным кодом по лицензии BSD 3-clause.
Что есть в редакторе из коробки?Блоки для сборки страниц перетаскиванием, менеджер стилей (Style Manager), менеджер слоёв (Layer Manager), просмотрщик кода (Code Viewer) и менеджер файлов (Asset Manager), а также встроенные команды и локальное и удалённое хранилище для сохранения работы.
Придётся ли строить интерфейс редактора с нуля?Нет — официальные пресеты дают готовые конструкторы (grapesjs-preset-webpage, grapesjs-preset-newsletter и grapesjs-mjml для рассылок на MJML), а обёртка @grapesjs/react позволяет собрать собственный декларативный интерфейс для редактора.
Можно ли расширять его плагинами?Да — есть официальные и сторонние плагины для самых разных задач: экспорт в zip, текстовый редактор на базе CKEditor, формы, навигационные панели, таймеры обратного отсчёта, свои шрифты, вкладки и поддержка сенсорных экранов. Можно написать и свой плагин.
Что такое Studio SDK, о котором говорится в README?Это готовый визуальный конструктор от команды GrapesJS, который встраивается во внешние приложения. Он предлагается как альтернатива сборке собственного редактора на фреймворке, с поддержкой командной работы в комплекте.
What are similar projects?puck, Kooboo, BlockNote, tui.editor, tinymce, lexical, ckeditor5, slate
Which topics is it in?website-builder, nocode, content-management-system, rich-text-editor, wysiwyg, templates, drag-and-drop, low-code, no-code, web-framework, editor, bsd
Creator
GrapesJS
Size
111.4 MB
Stars
26.3K
Updated
CommitOct 15Releasev0.23.8Oct 15
Age
10y
Commits · 90 Days