### Minimal Setup Example | Tiptap

Source: https://tiptap.dev/docs/comments/core-concepts/configure

Get started with Tiptap using the most basic setup. This example is ideal for understanding the core initialization process.

```javascript
import { Editor } from '@tiptap/core'

const editor = new Editor({
  content: '<p>Hello World!</p>',
})
```

--------------------------------

### Minimal Setup Example

Source: https://tiptap.dev/docs/content-ai/capabilities/generation/text-generation/custom-commands

Achieve a very minimal Tiptap text editor setup. This example provides the most basic configuration for getting started.

```javascript
import { useEditor, EditorContent } from '@tiptap/react'
import Document from '@tiptap/extension-document'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'

const editor = useEditor({
  extensions: [
    Document,
    Paragraph,
    Text,
  ],
})

return (
  <EditorContent editor={editor} />
)
```

--------------------------------

### Markdown - Getting Started

Source: https://tiptap.dev/docs/editor/api/commands/nodes-and-marks/toggle-mark

Guides for getting started with the Markdown module, including installation and basic usage.

```APIDOC
## Markdown - Getting Started

### Description
Guides to help you get started with the Markdown module.

### Sections
- Introduction: `/docs/editor/markdown`
- Getting Started: `/docs/editor/markdown/getting-started`
  - Installation & Setup: `/docs/editor/markdown/getting-started/installation`
  - Basic Usage: `/docs/editor/markdown/getting-started/basic-usage`
- Advanced Usage: `/docs/editor/markdown/advanced-usage`
  - Custom Tokenizer: `/docs/editor/markdown/advanced-usage/custom-tokenizer`
  - Custom Parsing: `/docs/editor/markdown/advanced-usage/custom-parsing`
  - Custom Serializing: `/docs/editor/markdown/advanced-usage/custom-serializing)`
```

--------------------------------

### Minimal Setup Example | Tiptap Editor Docs

Source: https://tiptap.dev/docs/conversion/import-export/markdown/rest-api

This example shows the absolute minimum setup required to get a Tiptap editor running. It's ideal for understanding the core components.

```javascript
import { useEditor, EditorContent } from "@tiptap/react";
import Document from "@tiptap/extension-document";
import Paragraph from "@tiptap/extension-paragraph";
import Text from "@tiptap/extension-text";

const extensions = [
  Document,
  Paragraph,
  Text,
];

const Tiptap = () => {
  const editor = useEditor({
    extensions,
    content: "<p>Hello World!</p>",
  });

  return <EditorContent editor={editor} />;
};

export default Tiptap;
```

--------------------------------

### Minimal Install Tiptap List Extension

Source: https://tiptap.dev/docs/editor/extensions/nodes/list-item

Example of how to import and use the Editor from Tiptap for a minimal setup.

```javascript
import { Editor } from "@tiptap/core"
import ListItem from "@tiptap/extension-list-item"
import OrderedList from "@tiptap/extension-ordered-list"
import BulletList from "@tiptap/extension-bullet-list"

const editor = new Editor({
  extensions: [
    ListItem,
    OrderedList,
    BulletList,
  ],
})
```

--------------------------------

### Minimal Setup Example

Source: https://tiptap.dev/docs/editor/api/commands/nodes-and-marks/delete-node

Learn how to create a very minimal text editor in Tiptap. This example provides the most basic setup.

```javascript
import { useEditor, EditorContent } from "@tiptap/react";
import Document from "@tiptap/extension-document";
import Paragraph from "@tiptap/extension-paragraph";
import Text from "@tiptap/extension-text";

const Editor = () => {
  const editor = useEditor({
    extensions: [
      Document,
      Paragraph,
      Text
    ],
    content: "<p>Hello World!</p>"
  });

  return <EditorContent editor={editor} />;
};

export default Editor;
```

--------------------------------

### Markdown - Installation & Setup API

Source: https://tiptap.dev/docs/editor/extensions/functionality/collaboration

Installation and setup guide for Markdown.

```APIDOC
## Documentation Link

### Description
Installation and setup for Markdown.

### Endpoint
/docs/editor/markdown/getting-started/installation
```

--------------------------------

### Install Server AI Toolkit

Source: https://tiptap.dev/docs/editor/api/commands/content/clear-content

Installation guide for the Server AI Toolkit, including configuration and setup.

```APIDOC
## Install Server AI Toolkit

### Description
Installation guide for the Server AI Toolkit. Learn how to install, configure authentication, and start using the Server AI Toolkit cloud service.

### Endpoint
/content-ai/capabilities/server-ai-toolkit/install.mdx
```

--------------------------------

### Minimal Install

Source: https://tiptap.dev/docs/editor/extensions/functionality/history

Minimal example of installing and using the UndoRedo extension.

```APIDOC
## Minimal Install

### Description
Minimal example of installing and using the UndoRedo extension.

### Method
JavaScript

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
import { Editor } from '@tiptap/core'
import { UndoRedo } from '@tiptap/extensions/undo-redo'

new Editor({
  extensions: [
    UndoRedo,
  ],
})
```

### Response
N/A
```

--------------------------------

### Minimal Setup Example

Source: https://tiptap.dev/docs/editor/extensions/functionality/drag-handle-react

Learn how to create a minimal setup for a Tiptap editor.

```markdown
Learn how to crea
```

--------------------------------

### Tracked Changes Getting Started

Source: https://tiptap.dev/docs/content-ai/capabilities/generation/custom-llms

Guides for installing and getting started with the Tiptap Tracked Changes extension.

```APIDOC
## Install Tracked Changes

### Description
Install and configure the Tracked Changes extension for suggestion mode in your Tiptap editor.

### Endpoint
/tracked-changes/getting-started/install.mdx
```

```APIDOC
## Tracked Changes Overview

### Description
Enable track changes and suggestion mode in your Tiptap editor for collaborative editing and document review.

### Endpoint
/tracked-changes/getting-started/overview.mdx
```

--------------------------------

### Minimal Setup Example

Source: https://tiptap.dev/docs/editor/extensions/custom-extensions/node-views

Set up a very minimal text editor using Tiptap. Consult the documentation for more details.

```javascript
import { useEditor, EditorContent } from '@tiptap/react'
import Document from '@tiptap/extension-document'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'

const editor = useEditor({
  extensions: [
    Document,
    Paragraph,
    Text,
  ],
  content: 'Hello World!',
})
```

--------------------------------

### Markdown Beta Features

Source: https://tiptap.dev/docs/editor/extensions/functionality/gapcursor

Documentation for the Markdown integration, including getting started, advanced usage, guides, and examples.

```APIDOC
## Markdown Beta Features

### Description
Documentation for the Markdown integration, including setup, usage, and guides.

### Sections
- **Introduction**: Introduction to Markdown integration.
- **Getting Started**: Initial setup and basic usage.
  - **Installation & Setup**: How to install and configure.
  - **Basic Usage**: Fundamental usage of Markdown features.
- **Advanced Usage**: More complex Markdown functionalities.
  - **Custom Tokenizer**: Creating custom tokenizers.
  - **Custom Parsing**: Customizing the parsing process.
  - **Custom Serializing**: Customizing the serialization process.
- **Guides**: Step-by-step guides for specific use cases.
  - **Integrate Markdown in your Extension**: Integrating Markdown into custom extensions.
  - **Create a Highlight Extension**: Building a highlight mark extension.
  - **Create a Admonition Extension**: Building an admonition block extension.
  - **Create a Emoji Extension**: Building an emoji inline block extension.
- **Examples**: Practical examples of Markdown integration.
- **API Reference**: Detailed API documentation for Markdown features.
- **Glossary**: Definitions of terms used in Markdown integration.
```

--------------------------------

### Tiptap CLI Installation Example

Source: https://tiptap.dev/docs/ui-components/getting-started/cli

Shows how to install Tiptap UI components using the Tiptap CLI. The `--force` flag can be used to overwrite existing files.

```bash
npx tiptap install ui
```

--------------------------------

### Markdown Beta Documentation

Source: https://tiptap.dev/docs/editor/api/commands/nodes-and-marks/toggle-node

Documentation for the Markdown beta features, including getting started, advanced usage, guides, and examples.

```APIDOC
## Markdown Beta Documentation

### Description
Documentation for the Markdown beta features.

### Introduction
- `/docs/editor/markdown`: Introduction to Markdown features.

### Getting Started
- `/docs/editor/markdown/getting-started`: General getting started guide.
- `/docs/editor/markdown/getting-started/installation`: Installation and setup instructions.
- `/docs/editor/markdown/getting-started/basic-usage`: Basic usage examples.

### Advanced Usage
- `/docs/editor/markdown/advanced-usage`: Advanced usage techniques.
- `/docs/editor/markdown/advanced-usage/custom-tokenizer`: Creating custom tokenizers.
- `/docs/editor/markdown/advanced-usage/custom-parsing`: Custom parsing logic.
- `/docs/editor/markdown/advanced-usage/custom-serializing`: Custom serialization logic.

### Guides
- `/docs/editor/markdown/guides`: Guides for using Markdown features.
- `/docs/editor/markdown/guides/integrate-markdown-in-your-extension`: Integrating Markdown into extensions.
- `/docs/editor/markdown/guides/create-a-highlight-mark`: Creating a highlight mark extension.
- `/docs/editor/markdown/guides/create-a-admonition-block`: Creating an admonition block extension.
- `/docs/editor/markdown/guides/create-a-emoji-inline-block`: Creating an emoji inline block extension.

### Examples
- `/docs/editor/markdown/examples`: Examples of Markdown usage.

### API Reference
- `/docs/editor/markdown/api`: Overview of the Markdown API.
- `/docs/editor/markdown/glossary`: Glossary of Markdown terms.
```

--------------------------------

### Markdown Beta Features

Source: https://tiptap.dev/docs/editor/getting-started/style-editor/custom-menus

Documentation for the beta version of Markdown integration, covering getting started, advanced usage, guides, and examples.

```APIDOC
## Markdown Beta

### Description
Information and guides for the beta release of the Markdown integration feature.

### Getting Started

#### Installation & Setup
- `/docs/editor/markdown/getting-started/installation`

#### Basic Usage
- `/docs/editor/markdown/getting-started/basic-usage`

### Advanced Usage

#### Custom Tokenizer
- `/docs/editor/markdown/advanced-usage/custom-tokenizer`

#### Custom Parsing
- `/docs/editor/markdown/advanced-usage/custom-parsing`

#### Custom Serializing
- `/docs/editor/markdown/advanced-usage/custom-serializing`

### Guides

#### Integrate Markdown in your Extension
- `/docs/editor/markdown/guides/integrate-markdown-in-your-extension`

#### Create a Highlight Extension
- `/docs/editor/markdown/guides/create-a-highlight-mark`

#### Create a Admonition Extension
- `/docs/editor/markdown/guides/create-a-admonition-block`

#### Create a Emoji Extension
- `/docs/editor/markdown/guides/create-a-emoji-inline-block`

### Examples
- `/docs/editor/markdown/examples`
```

--------------------------------

### Minimal Setup Example

Source: https://tiptap.dev/docs/editor/api/commands/selection/select-all

Learn how to create a very minimal text editor in Tiptap.

```javascript
import { Editor } from '@tiptap/core'

const editor = new Editor()

console.log(editor.getHTML())
// » <p></p>
```

--------------------------------

### Markdown Introduction Example

Source: https://tiptap.dev/docs/examples/advanced/react-performance

Get started with Markdown in Tiptap. Learn how to parse and render Markdown content in your Tiptap editor with our comprehensive guide.

```javascript
import Document from '@tiptap/extension-document'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
import History from '@tiptap/extension-history'
import Bold from '@tiptap/extension-bold'
import Italic from '@tiptap/extension-italic'
import Strike from '@tiptap/extension-strike'
import Underline from '@tiptap/extension-underline'
import Code from '@tiptap/extension-code'
import Heading from '@tiptap/extension-heading'
import BulletList from '@tiptap/extension-bullet-list'
import OrderedList from '@tiptap/extension-ordered-list'
import ListItem from '@tiptap/extension-list-item'
import Blockquote from '@tiptap/extension-blockquote'
import HardBreak from '@tiptap/extension-hard-break'
import HorizontalRule from '@tiptap/extension-horizontal-rule'
import Link from '@tiptap/extension-link'
import Image from '@tiptap/extension-image'
import CodeBlock from '@tiptap/extension-code-block'
import TextSelection from '@tiptap/extension-text-selection'
import Gapcursor from '@tiptap/extension-gapcursor'
import { Markdown } from '@tiptap/extension-markdown'

const editor = new Editor({
  extensions: [
    Document,
    Paragraph,
    Text,
    History,
    Bold,
    Italic,
    Strike,
    Underline,
    Code,
    Heading,
    BulletList,
    OrderedList,
    ListItem,
    Blockquote,
    HardBreak,
    HorizontalRule,
    Link,
    Image,
    CodeBlock,
    TextSelection,
    Gapcursor,
    Markdown.configure({
      html: true,
      // more options
    }),
  ],
})
```

--------------------------------

### Minimal Setup Example

Source: https://tiptap.dev/docs/editor/core-concepts/prosemirror

Learn how to create a very minimal text editor in Tiptap with a short code example.

```javascript
import { Editor } from '@tiptap/core'

const editor = new Editor({
  element: document.querySelector('#editor'),
})
```

--------------------------------

### Markdown - Getting Started API

Source: https://tiptap.dev/docs/editor/extensions/functionality/collaboration

Getting started guide for Markdown functionality.

```APIDOC
## Documentation Link

### Description
Getting started with Markdown.

### Endpoint
/docs/editor/markdown/getting-started
```

--------------------------------

### Minimal Setup Example | Tiptap

Source: https://tiptap.dev/docs/comments/getting-started/overview

Learn how to create a very minimal text editor in Tiptap.

```javascript
import { useEditor, EditorContent } from "@tiptap/react";
import Document from "@tiptap/extension-document";
import Paragraph from "@tiptap/extension-paragraph";
import Text from "@tiptap/extension-text";

const editor = useEditor({
  extensions: [
    Document,
    Paragraph,
    Text,
  ],
});
```

--------------------------------

### Create a Basic Text Editor with Tiptap

Source: https://tiptap.dev/docs/ui-components/primitives/dropdown-menu

Learn how to create a very basic text editor in Tiptap. This example demonstrates the minimal setup required to get started.

```javascript
import { EditorContent, useEditor } from "@tiptap/react";
import StarterKit from "@tiptap/starter-kit";

const extensions = [
  StarterKit,
];

const content = "<p>Hello World!</p>";

export default () => {
  const editor = useEditor({
    extensions,
    content,
  });

  return <EditorContent editor={editor} />;
};
```

--------------------------------

### Tiptap CLI Template Installation Example

Source: https://tiptap.dev/docs/ui-components/getting-started/cli

Illustrates installing Tiptap with a specific template (React, Vue, or Svelte) using the Tiptap CLI. The `--force` flag is used to ensure installation.

```bash
npx tiptap install --force --template=react
```

```bash
npx tiptap install --force --template=vue
```

```bash
npx tiptap install --force --template=svelte
```

--------------------------------

### Install Server AI Toolkit

Source: https://tiptap.dev/docs/editor/api/commands/selection/enter

Installation guide for the Tiptap Server AI Toolkit, covering setup, authentication, and usage.

```APIDOC
## Install Server AI Toolkit | Tiptap Content AI

### Description
Installation guide for the Server AI Toolkit. Learn how to install, configure authentication, and start using the Server AI Toolkit cloud service.

### Endpoint
/content-ai/capabilities/server-ai-toolkit/install.mdx
```

--------------------------------

### Install StarterKit Extension

Source: https://tiptap.dev/docs/editor/extensions/functionality/starterkit

Use npm to install the StarterKit extension. This is the recommended way to add it to your project.

```bash
npm install @tiptap/starter-kit
```

--------------------------------

### Install Tiptap AI Toolkit

Source: https://tiptap.dev/docs/content-ai/capabilities/generation/text-generation/stream

Installation guide for the AI Toolkit extension. Learn how to install, configure, and start using the AI Toolkit in your Tiptap editor.

```APIDOC
## Install Tiptap AI Toolkit

### Description
Installation guide for the AI Toolkit extension. Learn how to install, configure, and start using the AI Toolkit in your Tiptap editor.

### Endpoint
/content-ai/capabilities/ai-toolkit/install.mdx
```

--------------------------------

### Minimal Setup Example

Source: https://tiptap.dev/docs/ui-components/primitives/button

Learn how to create a very minimal text editor in Tiptap. More in our documentation!

```javascript
import { useEditor, EditorContent } from "@tiptap/react";
import Document from "@tiptap/extension-document";
import Paragraph from "@tiptap/extension-paragraph";
import Text from "@tiptap/extension-text";

const editor = useEditor({
  extensions: [
    Document,
    Paragraph,
    Text,
  ],
  content: "<p>Hello World!</p>",
});

return (
  <EditorContent editor={editor} />
);
```

--------------------------------

### Images Example

Source: https://tiptap.dev/docs/editor/getting-started/install/alpine

Demonstrates how to create a text editor that supports image insertion and manipulation in Tiptap. This example is a short code snippet to get started.

```javascript
import { EditorContent, useEditor } from '@tiptap/react'
import Image from '@tiptap/extension-image'
import StarterKit from '@tiptap/starter-kit'

const editor = useEditor({
  extensions: [
    StarterKit,
    Image,
  ],
  content: '<p>Hello World!</p><img src="/images/my-image.png" alt="My Image">', 
})

return (
  <EditorContent editor={editor} />
)
```

--------------------------------

### Import StarterKit and AiSuggestion

Source: https://tiptap.dev/docs/content-ai/capabilities/suggestion/install

Import necessary extensions for Tiptap editor initialization. Ensure '@tiptap/starter-kit' and '@tiptap-pro/extension-ai-suggestion' are installed.

```javascript
import StarterKit from '@tiptap/starter-kit'
import AiSuggestion from '@tiptap-pro/extension-ai-suggestion'
```

--------------------------------

### Markdown Guide

Source: https://tiptap.dev/docs/editor/api/commands

Documentation for integrating and using Markdown in Tiptap, including getting started, advanced usage, and guides for creating custom Markdown extensions.

```APIDOC
## Markdown Guide

### Introduction

- [Introduction](/docs/editor/markdown)

### Getting Started

- [Getting Started](/docs/editor/markdown/getting-started)
  - [Installation & Setup](/docs/editor/markdown/getting-started/installation)
  - [Basic Usage](/docs/editor/markdown/getting-started/basic-usage)

### Advanced Usage

- [Advanced Usage](/docs/editor/markdown/advanced-usage)
  - [Custom Tokenizer](/docs/editor/markdown/advanced-usage/custom-tokenizer)
  - [Custom Parsing](/docs/editor/markdown/advanced-usage/custom-parsing)
  - [Custom Serializing](/docs/editor/markdown/advanced-usage/custom-serializing)

### Guides

- [Guides](/docs/editor/markdown/guides)
  - [Integrate Markdown in your Extension](/docs/editor/markdown/guides/integrate-markdown-in-your-extension)
  - [Create a Highlight Extension](/docs/editor/markdown/guides/create-a-highlight-mark)
  - [Create a Admonition Extension](/docs/editor/markdown/guides/create-a-admonition-block)
  - [Create a Emoji Extension](/docs/editor/markdown/guides/create-a-emoji-inline-block)

### Examples

- [Examples](/docs/editor/markdown/examples)

```

--------------------------------

### Initialize Project with Tiptap CLI

Source: https://tiptap.dev/docs/ui-components/getting-started/cli

Use the 'init' command to set up your project configuration and install dependencies. You can specify components to add during initialization.

```bash
npx @tiptap/cli@latest init
```