Skip to content

Commit 1311887

Browse files
authored
Merge pull request #49 from ClayPulse/add-docs
Update some core concept docs
2 parents 6dad4da + e73800f commit 1311887

File tree

14 files changed

+80
-16
lines changed

14 files changed

+80
-16
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Pulse Editor
1111

1212
<div align="center">
1313

14+
[![Static Badge](https://img.shields.io/badge/docs-8A2BE2?style=for-the-badge)](https://docs.pulse-editor.com)
1415
[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/s6J54HFxQp)
1516
[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)
1617

docs/docs/guide/develop-extensions/_category_.json

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/docs/guide/develop-extensions/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Develop Extensions
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
# Development Guide
26

37
## Choose your framework
48

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Develop Extensions with React
2+
3+
## Create an extension project with React
4+
```bash
5+
pulse create --framework react
6+
```
7+
8+
## React Library
9+
The `@pulse-editor/react-api` is automatically installed if you create a project using the command above.
10+
11+
In this package, it provides many useful hooks for your extension to interact with Pulse Editor Core via [Inter-Module Communication (IMC)](/docs/guide/pulse-editor-app/extension-system/imc).

docs/docs/guide/develop-extensions/react/_category_.json

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/docs/guide/develop-extensions/react/index.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/docs/guide/develop-extensions/react/react-template.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/docs/guide/pulse-editor-app/_category_.json

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
15
# Concepts
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
6+
# Pulse Editor Core
7+
8+
## One Codebase, Every Platform
9+
Pulse Editor Core is developed using modern web technologies with Next.js, enabling a single codebase for all platforms. Its architecture is built around abstract interfaces, allowing native-specific implementations to plug in cleanly while maintaining a consistent core logic.
10+
11+
## Native Support via Electron and Capacitor
12+
After the app is built with Next.js, it is deployed to native platforms using Electron for desktop and Capacitor for mobile. This setup enables full native functionality across devices while preserving the benefits of a unified codebase.
13+

0 commit comments

Comments
 (0)