From e54dd76cd931d872ff9a24d74c375b3770fe39c3 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Fri, 5 Feb 2021 11:24:53 +0100 Subject: [PATCH] docs: update content --- docs/src/docPages/api/nodes/table-cell.md | 4 +- docs/src/docPages/api/nodes/table-header.md | 4 +- docs/src/docPages/api/nodes/table-row.md | 4 +- docs/src/docPages/api/nodes/table.md | 2 +- .../guide/getting-started/intertia.md | 125 ------------------ docs/src/links.yaml | 4 - 6 files changed, 4 insertions(+), 139 deletions(-) delete mode 100644 docs/src/docPages/guide/getting-started/intertia.md diff --git a/docs/src/docPages/api/nodes/table-cell.md b/docs/src/docPages/api/nodes/table-cell.md index fd03660e..243e2767 100644 --- a/docs/src/docPages/api/nodes/table-cell.md +++ b/docs/src/docPages/api/nodes/table-cell.md @@ -2,9 +2,7 @@ [![Version](https://img.shields.io/npm/v/@tiptap/extension-table-cell.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-table-cell) [![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-table-cell.svg)](https://npmcharts.com/compare/@tiptap/extension-table-cell?minimal=true) -:::warning ⚠️ Preview -Work in progress -::: +TODO ## Installation ::: warning Use with Table, TableRow and TableHeader diff --git a/docs/src/docPages/api/nodes/table-header.md b/docs/src/docPages/api/nodes/table-header.md index 20e5ffb9..208ca2df 100644 --- a/docs/src/docPages/api/nodes/table-header.md +++ b/docs/src/docPages/api/nodes/table-header.md @@ -2,9 +2,7 @@ [![Version](https://img.shields.io/npm/v/@tiptap/extension-table-header.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-table-header) [![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-table-header.svg)](https://npmcharts.com/compare/@tiptap/extension-table-header?minimal=true) -:::warning ⚠️ Preview -Work in progress -::: +TODO ## Installation ::: warning Use with Table, TableRow and TableCell diff --git a/docs/src/docPages/api/nodes/table-row.md b/docs/src/docPages/api/nodes/table-row.md index 90e443ee..4b0e06b9 100644 --- a/docs/src/docPages/api/nodes/table-row.md +++ b/docs/src/docPages/api/nodes/table-row.md @@ -2,9 +2,7 @@ [![Version](https://img.shields.io/npm/v/@tiptap/extension-table-row.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-table-row) [![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-table-row.svg)](https://npmcharts.com/compare/@tiptap/extension-table-row?minimal=true) -:::warning ⚠️ Preview -Work in progress -::: +TODO ## Installation ::: warning Use with Table, TableHeader and TableCell diff --git a/docs/src/docPages/api/nodes/table.md b/docs/src/docPages/api/nodes/table.md index 378cff28..220930fa 100644 --- a/docs/src/docPages/api/nodes/table.md +++ b/docs/src/docPages/api/nodes/table.md @@ -2,7 +2,7 @@ [![Version](https://img.shields.io/npm/v/@tiptap/extension-table.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-table) [![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-table.svg)](https://npmcharts.com/compare/@tiptap/extension-table?minimal=true) -⚠️ Work in progress +TODO ## Installation ::: warning Use with TableRow, TableHeader and TableCell diff --git a/docs/src/docPages/guide/getting-started/intertia.md b/docs/src/docPages/guide/getting-started/intertia.md deleted file mode 100644 index d4f05a50..00000000 --- a/docs/src/docPages/guide/getting-started/intertia.md +++ /dev/null @@ -1,125 +0,0 @@ -# Inertia.js - -## toc - -## Introduction -The following guide describes how to integrate tiptap with your [Inertia.js](https://inertiajs.com/) project. - -## toc - -TODO - -## Introduction -The following guide describes how to integrate tiptap with your Vue CLI project. If you’ve got Vue CLI on your machine already, you can skip the first step. - -## Requirements -* [Node](https://nodejs.org/en/download/) installed on your machine -* Experience with [Vue](https://vuejs.org/v2/guide/#Getting-Started) - -## 1. Install Vue CLI (optional) -Vue CLI aims to be the standard tooling baseline for the Vue ecosystem, and helps to create new projects quickly. If you’re working with Vue a lot, chances are you have this installed already. Just skip this step then. - -Here is how you could install (or update) it: - -```bash -# with npm -npm install -g @vue/cli - -# with Yarn -yarn global add @vue/cli -``` - -From now on, the `vue` command is available globally. Test it with `vue --version`, this should output the current version. - -## 2. Create a project (optional) -If you already have an existing Vue 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 fresh Vue project called `tiptap-example`. The Vue CLI sets up everything we need, just select the default Vue 2 template. - -```bash -# create a project -vue create tiptap-example - -# change directory -cd tiptap-example -``` - -## 3. Install the dependencies -Okay, enough of the boring boilerplate work. Let’s finally install tiptap! For the following example you’ll need `@tiptap/core` (the actual editor) and the `@tiptap/vue-starter-kit` which has everything to get started quickly, for example a few default extensions and a basic Vue component. - -```bash -# install with npm -npm install @tiptap/core @tiptap/vue-starter-kit - -# install with Yarn -yarn add @tiptap/core @tiptap/vue-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:8080/](http://localhost:3000/) in your favorite browser. This might be different, if you’re working with an existing project. - -## 4. Create a new component -To actually start using tiptap, you’ll need to add a new component to your app. Let’s call it `Tiptap` and put the following example code in `components/Tiptap.vue`. - -This is the fastest way to get tiptap up and running with Vue. It will give you a very basic version of tiptap, without any buttons. No worries, you will be able to add more functionality soon. - -```html - - - -``` - -## 5. Add it to your app -Now, let’s replace the content of `src/App.vue` with the following example code to use our new `Tiptap` component in our app. - -```html - - - -``` - -You should now see tiptap in your browser. You’ve successfully set up tiptap! Time to give yourself a pat on the back. Let’s start to configure your editor in the next step. - -## 6. Use v-model (optional) -You’re probably used to bind your data with `v-model` in forms, that’s also possible with tiptap. Here is a working example component, that you can integrate in your project: - - diff --git a/docs/src/links.yaml b/docs/src/links.yaml index 281b8af3..7b69f13e 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -52,10 +52,6 @@ - title: Nuxt.js link: /guide/getting-started/nuxt skip: true - - title: Inertia.js - link: /guide/getting-started/intertia - type: draft - skip: true - title: React link: /guide/getting-started/react type: draft