tsai
/
grapesjs
mirror of https://github.com/artf/grapesjs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Free and Open source Web Builder Framework. Next generation tool for building templates without coding
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6127 Commits
198 Branches
159 Tags
125 MiB
 
 
 
 
Tree: 506e3494a5
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '506e3494a5'
${ noResults }
CanGrapesJS 506e3494a5
Add custom renderer hook (#6505) 		9 months ago
.github Up dependabot 10 months ago
docs Release GrapesJS docs: v0.22.6 (#6470) 10 months ago
packages Add custom renderer hook (#6505) 9 months ago
scripts ci: add doc release runner (#6240) 1 year ago
.eslintrc.js feat: inital move cli to mono-repo (#6126) 1 year ago
.gitignore init: pnpm setup (#6114) 1 year ago
.prettierignore feat: inital move cli to mono-repo (#6126) 1 year ago
.prettierrc init: pnpm setup (#6114) 1 year ago
CODE_OF_CONDUCT.md development environment upgrades (#6059) 1 year ago
CONTRIBUTING.md Update Contributing.md to add build step. (#6466) 10 months ago
LICENSE Fix docs api (#6284) 1 year ago
README.md Add collection components (#6359) 1 year ago
package.json build(deps-dev): bump @babel/cli from 7.24.8 to 7.27.0 (#6476) 10 months ago
pnpm-lock.yaml build(deps-dev): bump @babel/cli from 7.24.8 to 7.27.0 (#6476) 10 months ago
pnpm-workspace.yaml feat: inital move cli to mono-repo (#6126) 1 year ago

docs/README.md

Introduction

toc

::: tip

Supercharge your web builder with the Grapes Studio SDK — a customizable GrapesJS experience, complete with a polished UI that’s ready to embed.

:::

What is GrapesJS?

At first glance one might think this is just another page/HTML builder, but it's something more. GrapesJS is a multi-purpose, Web Builder Framework, which means it allows you to easily create a drag & drop enabled builder of "things". By "things" we mean anything with HTML-like structure, which entails much more than web pages. We use HTML-like structure basically everywhere: Newsletters (eg. MJML), Native Mobile Applications (eg. React Native), Native Desktop Applications (eg. Vuido), PDFs (eg. React PDF), etc. So, for everything you can imagine as a set of elements like <tag some="attribute">... other nested elements ...</tag> you can create easily a GrapesJS builder around it and then use it independently in your applications. GrapesJS ships with features and tools that enable you to craft easy to use builders. Which allows your users to create complex HTML-like templates without any knowledge of coding.

Why GrapesJS?

GrapesJS was designed primarily for use inside Content Management Systems to speed up the creation of dynamic templates and replace common WYSIWYG editors, which are good for content editing, but inappropriate for creating HTML structures. Instead of creating an application we decided to create an extensible framework that could be used by anyone for any purpose.

Quick Start

To showcase the power of GrapesJS we have created some presets.

You can actually use them as a starting point for your editors, so, just follow the instructions on their repositories to get a quick start for your builder.

Download

Latest version: npm

You can download GrapesJS from one of these sources

  • CDNs
    • unpkg
      • https://unpkg.com/grapesjs
      • https://unpkg.com/grapesjs/dist/css/grapes.min.css
    • cdnjs
      • https://cdnjs.cloudflare.com/ajax/libs/grapesjs/0.12.17/grapes.min.js
      • https://cdnjs.cloudflare.com/ajax/libs/grapesjs/0.12.17/css/grapes.min.css
  • npm
    • npm i grapesjs
  • git
    • git clone https://github.com/GrapesJS/grapesjs.git

Changelog

To track changes made in the library we rely on Github Releases