Skip to content

Commit 5a7c828

Browse files
griffinkellyartf
andauthored
Update Contributing.md to add build step. (#6466)
* Update Contributing.md to add build step. Update Grapes Docs. * Update for utm tracking * Formatting * Vary copy --------- Co-authored-by: Artur Arseniev <[email protected]>
1 parent f067e3f commit 5a7c828

12 files changed

+56
-2
lines changed

CONTRIBUTING.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,19 @@ Thank you for your interest in contributing to GrapesJS! We welcome all types of
3737
pnpm install
3838
```
3939

40-
5. Start the development server:
40+
5. Run the build script:
41+
42+
```bash
43+
pnpm run build
44+
```
45+
46+
6. Start the development server:
4147

4248
```bash
4349
pnpm start
4450
```
4551

46-
6. Open `http://localhost:8080/` in your browser to see the editor in action.
52+
7. Open `http://localhost:8080/` in your browser to see the editor in action.
4753

4854
## Development Workflow
4955

docs/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
[[toc]]
44

5+
::: tip
6+
7+
Supercharge your web builder with the [Grapes Studio SDK](https://app.grapesjs.com/docs-sdk/overview/getting-started) — a customizable GrapesJS experience, complete with a polished UI that’s ready to embed.
8+
9+
:::
10+
11+
512
## What is GrapesJS?
613

714
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](https://mjml.io/)), Native Mobile Applications (eg. [React Native](https://github.com/facebook/react-native)), Native Desktop Applications (eg. [Vuido](https://vuido.mimec.org)), PDFs (eg. [React PDF](https://github.com/diegomura/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.

docs/getting-started.md

+6
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ meta:
1010

1111
This is a step-by-step guide for anyone who wants to create their own builder with GrapesJS. This is not a comprehensive guide, just a concise overview of the most common modules. Follow along to create a page builder from scratch. Skip to the end of this page to see the [final result](#final-result).
1212

13+
::: tip
14+
15+
Looking for a customizable version of GrapesJS with an embeddable, production-ready UI? [Explore the Grapes Studio SDK!](https://app.grapesjs.com/docs-sdk/overview/getting-started)
16+
17+
:::
18+
1319
## Import the library
1420

1521
Before you start using GrapesJS, you'll have to import it. Let's import the latest version:

docs/modules/Assets.md

+4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ title: Asset Manager
88

99
In this section, you will see how to setup and take the full advantage of built-in Asset Manager in GrapesJS. The Asset Manager is lightweight and implements just an `image` in its core, but as you'll see next it's easy to extend and create your own asset types.
1010

11+
::: tip
12+
Want an asset manager that looks great out of the box? [Try the Grapes Studio SDK!](https://app.grapesjs.com/docs-sdk/configuration/assets/overview?utm_source=grapesjs-docs&utm_medium=tip)
13+
:::
14+
1115
[[toc]]
1216

1317
## Configuration

docs/modules/Blocks.md

+4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ To get a better understanding of the content in this guide, we recommend reading
1616
This guide is referring to GrapesJS v0.17.27 or higher
1717
:::
1818

19+
::: tip
20+
Need a sleek block UI that’s easy to extend and customize? [Explore the Grapes Studio SDK!](https://app.grapesjs.com/docs-sdk/configuration/blocks?utm_source=grapesjs-docs&utm_medium=tip)
21+
:::
22+
1923
[[toc]]
2024

2125
## Configuration

docs/modules/Components-js.md

+4
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ This guide is referring to GrapesJS v0.16.34 or higher.<br><br>
1111
To get a better understanding of the content in this guide, we recommend reading [Components](Components.html) and [Traits] first
1212
:::
1313

14+
::: tip
15+
Prefer a modern UI that's production-ready? [Get started with the Grapes Studio SDK!](https://app.grapesjs.com/docs-sdk/configuration/components/overview?utm_source=grapesjs-docs&utm_medium=tip)
16+
:::
17+
1418
[[toc]]
1519

1620
## Basic scripts

docs/modules/Components.md

+4
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ The Component is a base element of the template. It might be something simple an
1010
This guide is referring to GrapesJS v0.15.8 or higher
1111
:::
1212

13+
::: tip
14+
Skip the boilerplate—use a refined component editor out of the box. [Checkout the Grapes Studio SDK!](https://app.grapesjs.com/docs-sdk/configuration/components/overview?utm_source=grapesjs-docs&utm_medium=tip)
15+
:::
16+
1317
[[toc]]
1418

1519
## How Components work?

docs/modules/Pages.md

+3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ The Pages module in GrapesJS allows you to create a project with multiple pages.
1010
This guide is referring to GrapesJS v0.21.1 or higher
1111
:::
1212

13+
::: tip
14+
Want pages to just work, with a polished UI? [See how the Grapes Studio SDK does it!](https://app.grapesjs.com/docs-sdk/configuration/pages?utm_source=grapesjs-docs&utm_medium=tip)
15+
:::
1316
[[toc]]
1417

1518
## Initialization

docs/modules/Plugins.md

+4
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Creating plugins in GrapesJS is pretty straightforward and here you'll get how t
1010
This guide is referring to GrapesJS v0.21.2 or higher
1111
:::
1212

13+
::: tip
14+
Looking for plugins that are tested, verified, and built to scale? [Browse them all in the Grapes Studio SDK!](https://app.grapesjs.com/docs-sdk/plugins/overview?utm_source=grapesjs-docs&utm_medium=tip)
15+
:::
16+
1317
[[toc]]
1418

1519
## Basic plugin

docs/modules/Storage.md

+4
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ The Storage Manager is a built-in module that allows the persistence of your pro
1010
This guide requires GrapesJS v0.19.\* or higher
1111
:::
1212

13+
::: tip
14+
Need more powerful and customizable storage options? [The Grapes Studio SDK has you covered.](https://app.grapesjs.com/docs-sdk/configuration/projects?utm_source=grapesjs-docs&utm_medium=tip#storage)
15+
:::
16+
1317
[[toc]]
1418

1519
## Configuration

docs/modules/Style-manager.md

+4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ To get a better understanding of the content in this guide, we recommend reading
1616
This guide is referring to GrapesJS v0.18.1 or higher
1717
:::
1818

19+
::: tip
20+
Looking for a UI that is easy and ready to customize? [Checkout the Grapes Studio SDK!](https://app.grapesjs.com/docs-sdk/configuration/components/overview?utm_source=grapesjs-docs&utm_medium=tip)
21+
:::
22+
1923
[[toc]]
2024

2125
## Configuration

docs/modules/Traits.md

+4
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ This guide is referring to GrapesJS v0.21.9 or higher.<br><br>
1111
To get a better understanding of the content in this guide we recommend reading [Components](Components.html) first
1212
:::
1313

14+
::: tip
15+
Want traits that look great and work out of the box? [See how the Grapes Studio SDK handles it.](https://app.grapesjs.com/docs-sdk/configuration/components/properties?utm_source=grapesjs-docs&utm_medium=tip#traits)
16+
:::
17+
1418
[[toc]]
1519

1620
## Add Traits to Components

0 commit comments

Comments
 (0)