ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge branch 'main' of github.com:ueberdosis/tiptap

Browse Source 
# Conflicts:
#	docs/api/extensions/unique-id.md
This commit is contained in:
Hans Pagel
2021-10-07 21:03:01 +02:00
parent c5f025909e 8b82fbee80
commit e769063921
45 changed files with 380 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/extensions.md
View File

@@ -23,7 +23,7 @@ There are also some extensions with more capabilities. We call them [nodes](/api
| [History](/api/extensions/history) | Included | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-history/) |
| [Placeholder](/api/extensions/placeholder) | – | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-placeholder/) |
| [TextAlign](/api/extensions/text-align) | – | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-text-align/) |
| [UniqueId](/api/extensions/unique-id) | – | Requires a tiptap pro subscription |
| [UniqueID](/api/extensions/unique-id) | – | Requires a tiptap pro subscription |
| [Typography](/api/extensions/typography) | – | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-typography/) |
You don’t have to use it, but we prepared a `@tiptap/starter-kit` which includes the most common extensions. Read more about [`StarterKit`](/guide/configuration#default-extensions).

2
docs/api/nodes/hard-break.md
View File

@@ -43,7 +43,7 @@ HardBreak.configure({
Add a line break.
```js
editor.commands.setHeardBreak()
editor.commands.setHardBreak()
```
## Keyboard shortcuts

1
docs/installation.md
View File

@@ -10,6 +10,7 @@ tiptap is framework-agnostic and even works with Vanilla JavaScript (if that’s
## Integration guides
* [CDN](/installation/cdn)
* [React](/installation/react)
* [Next.js](/installation/nextjs)
* [Vue 3](/installation/vue3)
* [Vue 2](/installation/vue2)
* [Nuxt.js](/installation/nuxt)

75
docs/installation/nextjs.md Normal file
View File

@@ -0,0 +1,75 @@
---
title: Next.js WYSIWYG
tableOfContents: true
---
# Next.js
## Introduction
The following guide describes how to integrate tiptap with your [Next.js](https://nextjs.org/) project.
## Requirements
* [Node](https://nodejs.org/en/download/) installed on your machine
* Experience with [React](https://reactjs.org/)
## 1. Create a project (optional)
If you already have an existing Next.js project, that’s fine too. Just skip this step and proceed with the next step.
For the sake of this guide, let’s start with a new Next.js project called `tiptap-example`. The following command sets up everything we need to get started.
```bash
# create a project
npx create-next-app tiptap-example
# change directory
cd tiptap-example
```
## 2. Install the dependencies
Now that we have a standard boilerplate set up we can get started on getting tiptap up and running! For this we will need to install two packages: `@tiptap/react` and `@tipta/starter-kit` which includes all the extensions you need to get started quickly.
```bash
# install with npm
npm install @tiptap/react @tiptap/starter-kit
# install with Yarn
yarn add @tiptap/react @tiptap/starter-kit
```
If you followed step 1 and 2, you can now start your project with `npm run dev` or `yarn dev`, and open [http://localhost:3000/](http://localhost:3000/) in your favorite browser. This might be different, if you’re working with an existing project.
## 3. Create a new component
To actually start using tiptap, you’ll need to add a new component to your app. To do this, first create a directory called `components/`. Now it's time to create our component which we'll call `Tiptap`. To do this put the following example code in `components/Tiptap.js`.
```jsx
import { useEditor, EditorContent } from '@tiptap/react'
import StarterKit from '@tiptap/starter-kit'
const Tiptap = () => {
const editor = useEditor({
extensions: [
StarterKit,
],
content: '<p>Hello World! 🌎️</p>',
})
return (
<EditorContent editor={editor} />
)
}
export default Tiptap;
```
## 4. Add it to your app
Now, let’s replace the content of `pages/index.js` with the following example code to use our new `Tiptap` component in our app.
```jsx
import Tiptap from '../components/Tiptap'
export default function Home() {
return (
<Tiptap />
)
}
```
You should now see tiptap in your browser. Time to give yourself a pat on the back! :)

8
docs/installation/react.md
View File

@@ -12,6 +12,14 @@ The following guide describes how to integrate tiptap with your [React](https://
* [Node](https://nodejs.org/en/download/) installed on your machine
* Experience with [React](https://reactjs.org/docs/getting-started.html)
## Using a template
If you just want to get up and running with tiptap you can use the [tiptap Create React App template](https://github.com/alb/cra-template-tiptap) by [@alb](https://github.com/alb) to automatically create a new project with all the steps below already completed.
```bash
# create a project based on the tiptap template
npx create-react-app tiptap-example --template tiptap
```
## 1. Create a project (optional)
If you already have an existing React project, that’s fine too. Just skip this step and proceed with the next step.

5
docs/links.yaml
View File

@@ -21,6 +21,9 @@
- title: React
link: /installation/react
skip: true
- title: Next.js
link: /installation/nextjs
skip: true
- title: Vue 3
link: /installation/vue3
skip: true
@@ -361,7 +364,7 @@
link: /api/extensions/text-align
- title: Typography
link: /api/extensions/typography
- title: UniqueId
- title: UniqueID
link: /api/extensions/unique-id
type: pro
- title: Utilities