adding types to linter extension and it's plugins

2021-06-09 02:11:37 +05:30
parent 224bb31d82
commit 962c124d09
84 changed files with 1007 additions and 268 deletions
--- a/docs/src/docPages/api/marks.md
+++ b/docs/src/docPages/api/marks.md
@@ -6,13 +6,15 @@
 One or multiple marks can be applied to [nodes](/api/nodes), for example to add inline formatting like bold and italic, or other additional information.

 ## List of supported marks
-| Title                              | Default Extension | Source Code                                                                                  |
-| ---------------------------------- | ----------------- | -------------------------------------------------------------------------------------------- |
-| [Bold](/api/marks/bold)            | Yes               | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-bold/)       |
-| [Code](/api/marks/code)            | Yes               | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code/)       |
-| [Highlight](/api/marks/highlight)  | –                 | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-highlight/)  |
-| [Italic](/api/marks/italic)        | Yes               | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-italic/)     |
-| [Link](/api/marks/link)            | –                 | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-link/)       |
-| [Strike](/api/marks/strike)        | Yes               | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-strike/)     |
-| [TextStyle](/api/marks/text-style) | Yes               | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-text-style/) |
-| [Underline](/api/marks/underline)  | –                 | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-underline/)  |
+| Title                                 | Default Extension | Source Code                                                                              |
+| ------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------- |
+| [Bold](/api/marks/bold)               | Yes               | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-bold/)        |
+| [Code](/api/marks/code)               | Yes               | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code/)        |
+| [Highlight](/api/marks/highlight)     | –                 | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-highlight/)   |
+| [Italic](/api/marks/italic)           | Yes               | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-italic/)      |
+| [Link](/api/marks/link)               | –                 | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-link/)        |
+| [Strike](/api/marks/strike)           | Yes               | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-strike/)      |
+| [Subscript](/api/marks/subscript)     | –                 | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-subscript/)   |
+| [Superscript](/api/marks/superscript) | –                 | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-superscript/) |
+| [TextStyle](/api/marks/text-style)    | Yes               | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-text-style/)  |
+| [Underline](/api/marks/underline)     | –                 | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-underline/)   |
--- a/docs/src/docPages/api/marks/subscript.md
+++ b/docs/src/docPages/api/marks/subscript.md
@@ -0,0 +1,32 @@
+# Subscript
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-subscript.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-subscript)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-subscript.svg)](https://npmcharts.com/compare/@tiptap/extension-subscript?minimal=true)
+
+Use this extension to render text in <sub>subscript</sub>. If you pass `<sub>` or text with `vertical-align: sub` as inline style in the editor’s initial content, both will be normalized to a `<sub>` HTML tag.
+
+## Installation
+```bash
+# with npm
+npm install @tiptap/extension-subscript
+
+# with Yarn
+yarn add @tiptap/extension-subscript
+```
+
+## Settings
+| Option         | Type     | Default | Description                                                           |
+| -------------- | -------- | ------- | --------------------------------------------------------------------- |
+| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
+
+## Commands
+| Command         | Parameters | Description               |
+| --------------- | ---------- | ------------------------- |
+| setSubscript    | —          | Mark text as subscript. |
+| toggleSubscript | —          | Toggle subscript mark.  |
+| unsetSubscript  | —          | Remove subscript mark.  |
+
+## Source code
+[packages/extension-subscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-subscript/)
+
+## Usage
+<demo name="Marks/Subscript" highlight="3-5,16,35" />
--- a/docs/src/docPages/api/marks/superscript.md
+++ b/docs/src/docPages/api/marks/superscript.md
@@ -0,0 +1,32 @@
+# Superscript
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-superscript.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-superscript)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-superscript.svg)](https://npmcharts.com/compare/@tiptap/extension-superscript?minimal=true)
+
+Use this extension to render text in <sup>superscript</sup>. If you pass `<sup>` or text with `vertical-align: super` as inline style in the editor’s initial content, both will be normalized to a `<sup>` HTML tag.
+
+## Installation
+```bash
+# with npm
+npm install @tiptap/extension-superscript
+
+# with Yarn
+yarn add @tiptap/extension-superscript
+```
+
+## Settings
+| Option         | Type     | Default | Description                                                           |
+| -------------- | -------- | ------- | --------------------------------------------------------------------- |
+| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
+
+## Commands
+| Command           | Parameters | Description               |
+| ----------------- | ---------- | ------------------------- |
+| setSuperscript    | —          | Mark text as superscript. |
+| toggleSuperscript | —          | Toggle superscript mark.  |
+| unsetSuperscript  | —          | Remove superscript mark.  |
+
+## Source code
+[packages/extension-superscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-superscript/)
+
+## Usage
+<demo name="Marks/Superscript" highlight="3-5,17,36" />
--- a/docs/src/docPages/experiments/linter.md
+++ b/docs/src/docPages/experiments/linter.md
@@ -1,5 +1,5 @@
 # Linter

-⚠️ Experiment
+Linter can be used to check the content as per your wish and highlight it to the user. Linter extension can have multiple plugins for each task you want to achieve.

 <demo name="Experiments/Linter" />
--- a/docs/src/docPages/jobs.md
+++ b/docs/src/docPages/jobs.md
@@ -2,6 +2,9 @@

 Some great companies are looking for developers with tiptap or hocuspocus experience right now. If you’re looking for a job to work with tiptap and/or hocuspocus, consider applying:

+**[Frontend Developer](https://bitcrowd.net/jobs) @ bitcrowd**<br>
+tiptap · Remote · Germany · Full-time
+
 **[Software Engineer, Fullstack](https://saga.so/careers/software-engineer-fullstack) @ Saga**<br>
 hocuspocus · Remote · EU time zones · Full-time