From 8f00a09b76b3dd97c0c596778d7ddbfbdb4d4449 Mon Sep 17 00:00:00 2001
From: Hans Pagel <hans.pagel@ueber.io>
Date: Fri, 13 Nov 2020 15:46:55 +0100
Subject: [PATCH] add styles to examples, add content to the typescript page

---
 docs/src/demos/Examples/Basic/index.vue       | 47 +++++++++++++
 .../Examples/CollaborativeEditing/index.vue   | 45 +++++++++++++
 .../demos/Examples/ExportHtmlOrJson/index.vue | 46 +++++++++++++
 docs/src/demos/Examples/Links/index.vue       | 14 ++++
 .../Examples/MarkdownShortcuts/index.vue      | 59 ++++++++++++++++-
 docs/src/demos/Examples/Minimalist/index.vue  |  9 +++
 docs/src/demos/Examples/ReadOnly/index.vue    |  7 ++
 .../docPages/guide/working-with-typescript.md | 41 +++++++++++-
 docs/src/layouts/App/base.scss                | 66 +++++++++----------
 docs/src/links.yaml                           |  1 -
 10 files changed, 298 insertions(+), 37 deletions(-)

diff --git a/docs/src/demos/Examples/Basic/index.vue b/docs/src/demos/Examples/Basic/index.vue
index f2597399..6bcbf6b5 100644
--- a/docs/src/demos/Examples/Basic/index.vue
+++ b/docs/src/demos/Examples/Basic/index.vue
@@ -124,3 +124,50 @@ export default {
   },
 }
 </script>
+
+<style lang="scss">
+/* Basic editor styles */
+.ProseMirror {
+  > * + * {
+    margin-top: 0.75em;
+  }
+
+  ul,
+  ol {
+    padding: 0 1rem;
+  }
+
+  code {
+    background-color: rgba(#616161, 0.1);
+    color: #616161;
+  }
+
+  pre {
+    background: #0D0D0D;
+    color: #FFF;
+    font-family: 'JetBrainsMono', monospace;
+    padding: 0.75rem 1rem;
+    border-radius: 0.5rem;
+
+    code {
+      color: inherit;
+      background: none;
+      font-size: 0.8rem;
+    }
+  }
+
+  img {
+    max-width: 100%;
+    height: auto;
+  }
+
+  hr {
+    margin: 1rem 0;
+  }
+
+  blockquote {
+    padding-left: 1rem;
+    border-left: 2px solid rgba(#0D0D0D, 0.1);
+  }
+}
+</style>
diff --git a/docs/src/demos/Examples/CollaborativeEditing/index.vue b/docs/src/demos/Examples/CollaborativeEditing/index.vue
index b9c65f58..36403f81 100644
--- a/docs/src/demos/Examples/CollaborativeEditing/index.vue
+++ b/docs/src/demos/Examples/CollaborativeEditing/index.vue
@@ -281,4 +281,49 @@ export default {
   border-radius: 3px;
   white-space: nowrap;
 }
+
+/* Basic editor styles */
+.ProseMirror {
+  > * + * {
+    margin-top: 0.75em;
+  }
+
+  ul,
+  ol {
+    padding: 0 1rem;
+  }
+
+  code {
+    background-color: rgba(#616161, 0.1);
+    color: #616161;
+  }
+
+  pre {
+    background: #0D0D0D;
+    color: #FFF;
+    font-family: 'JetBrainsMono', monospace;
+    padding: 0.75rem 1rem;
+    border-radius: 0.5rem;
+
+    code {
+      color: inherit;
+      background: none;
+      font-size: 0.8rem;
+    }
+  }
+
+  img {
+    max-width: 100%;
+    height: auto;
+  }
+
+  hr {
+    margin: 1rem 0;
+  }
+
+  blockquote {
+    padding-left: 1rem;
+    border-left: 2px solid rgba(#0D0D0D, 0.1);
+  }
+}
 </style>
diff --git a/docs/src/demos/Examples/ExportHtmlOrJson/index.vue b/docs/src/demos/Examples/ExportHtmlOrJson/index.vue
index d5a53f87..e7c2ccb6 100644
--- a/docs/src/demos/Examples/ExportHtmlOrJson/index.vue
+++ b/docs/src/demos/Examples/ExportHtmlOrJson/index.vue
@@ -105,6 +105,7 @@ export default {
 </script>
 
 <style lang="scss">
+/* Style the export */
 .export {
   padding: 1rem 0 0;
 
@@ -126,4 +127,49 @@ export default {
     color: #495057;
   }
 }
+
+/* Basic editor styles */
+.ProseMirror {
+  > * + * {
+    margin-top: 0.75em;
+  }
+
+  ul,
+  ol {
+    padding: 0 1rem;
+  }
+
+  code {
+    background-color: rgba(#616161, 0.1);
+    color: #616161;
+  }
+
+  pre {
+    background: #0D0D0D;
+    color: #FFF;
+    font-family: 'JetBrainsMono', monospace;
+    padding: 0.75rem 1rem;
+    border-radius: 0.5rem;
+
+    code {
+      color: inherit;
+      background: none;
+      font-size: 0.8rem;
+    }
+  }
+
+  img {
+    max-width: 100%;
+    height: auto;
+  }
+
+  hr {
+    margin: 1rem 0;
+  }
+
+  blockquote {
+    padding-left: 1rem;
+    border-left: 2px solid rgba(#0D0D0D, 0.1);
+  }
+}
 </style>
diff --git a/docs/src/demos/Examples/Links/index.vue b/docs/src/demos/Examples/Links/index.vue
index e3240fc7..933dd0f8 100644
--- a/docs/src/demos/Examples/Links/index.vue
+++ b/docs/src/demos/Examples/Links/index.vue
@@ -64,3 +64,17 @@ export default {
   },
 }
 </script>
+
+<style lang="scss">
+/* Basic editor styles */
+.ProseMirror {
+  > * + * {
+    margin-top: 0.75em;
+  }
+
+  a {
+    text-decoration: underline;
+    color: blue;
+  }
+}
+</style>
diff --git a/docs/src/demos/Examples/MarkdownShortcuts/index.vue b/docs/src/demos/Examples/MarkdownShortcuts/index.vue
index f67923d3..d2176b57 100644
--- a/docs/src/demos/Examples/MarkdownShortcuts/index.vue
+++ b/docs/src/demos/Examples/MarkdownShortcuts/index.vue
@@ -6,6 +6,8 @@
 
 <script>
 import { Editor, EditorContent, defaultExtensions } from '@tiptap/vue-starter-kit'
+import Strike from '@tiptap/extension-strike'
+import Highlight from '@tiptap/extension-highlight'
 
 export default {
   components: {
@@ -28,10 +30,16 @@ export default {
           To test that, start a new line and type <code>#</code> followed by a space to get a heading. Try <code>#</code>, <code>##</code>, <code>###</code>, <code>####</code>, <code>#####</code>, <code>######</code> for different levels.
         </p>
         <p>
-          Those conventions are called input rules in tiptap. Some of them are enabled by default. Try <code>></code> for blockquotes, <code>*</code>, <code>-</code> or <code>+</code> for bullet lists, or <code>\`foobar\`</code> to highlight code. You can add your own input rules to existing extensions, and to your custom nodes and marks.
+          Those conventions are called input rules in tiptap. Some of them are enabled by default. Try <code>></code> for blockquotes, <code>*</code>, <code>-</code> or <code>+</code> for bullet lists, or <code>\`foobar\`</code> to highlight code, <code>~~tildes~~</code> to strike text, or <code>==equal signs==</code> to highlight text.
+        </p>
+        <p>
+          You can overwrite existing input rules or add your own to new nodes and marks.
         </p>
       `,
-      extensions: defaultExtensions(),
+      extensions: [
+        ...defaultExtensions(),
+        Highlight(),
+      ],
     })
   },
 
@@ -40,3 +48,50 @@ export default {
   },
 }
 </script>
+
+<style lang="scss">
+/* Basic editor styles */
+.ProseMirror {
+  > * + * {
+    margin-top: 0.75em;
+  }
+
+  ul,
+  ol {
+    padding: 0 1rem;
+  }
+
+  code {
+    background-color: rgba(#616161, 0.1);
+    color: #616161;
+  }
+
+  pre {
+    background: #0D0D0D;
+    color: #FFF;
+    font-family: 'JetBrainsMono', monospace;
+    padding: 0.75rem 1rem;
+    border-radius: 0.5rem;
+
+    code {
+      color: inherit;
+      background: none;
+      font-size: 0.8rem;
+    }
+  }
+
+  img {
+    max-width: 100%;
+    height: auto;
+  }
+
+  hr {
+    margin: 1rem 0;
+  }
+
+  blockquote {
+    padding-left: 1rem;
+    border-left: 2px solid rgba(#0D0D0D, 0.1);
+  }
+}
+</style>
diff --git a/docs/src/demos/Examples/Minimalist/index.vue b/docs/src/demos/Examples/Minimalist/index.vue
index 9b676326..8f53dc21 100644
--- a/docs/src/demos/Examples/Minimalist/index.vue
+++ b/docs/src/demos/Examples/Minimalist/index.vue
@@ -42,3 +42,12 @@ export default {
   },
 }
 </script>
+
+<style lang="scss">
+/* Basic editor styles */
+.ProseMirror {
+  > * + * {
+    margin-top: 0.75em;
+  }
+}
+</style>
diff --git a/docs/src/demos/Examples/ReadOnly/index.vue b/docs/src/demos/Examples/ReadOnly/index.vue
index 08e61ba5..a4f16e8f 100644
--- a/docs/src/demos/Examples/ReadOnly/index.vue
+++ b/docs/src/demos/Examples/ReadOnly/index.vue
@@ -53,6 +53,13 @@ export default {
 </script>
 
 <style lang="scss">
+/* Basic editor styles */
+.ProseMirror {
+  > * + * {
+    margin-top: 0.75em;
+  }
+}
+
 .checkbox {
   margin-bottom: 1rem;
 
diff --git a/docs/src/docPages/guide/working-with-typescript.md b/docs/src/docPages/guide/working-with-typescript.md
index 72678065..37dbdc1e 100644
--- a/docs/src/docPages/guide/working-with-typescript.md
+++ b/docs/src/docPages/guide/working-with-typescript.md
@@ -3,10 +3,49 @@
 ## toc
 
 ## Introduction
+The whole tiptap is code base is written in TypeScript. If you haven’t heard of it or never used it, no worries. You don’t have to.
 
+TypeScript extends JavaScript by adding types (hence the name). It adds new syntax, which doesn’t exist in plain JavaScript. It’s actually removed before running in the browser, but this step – the compilation – is important to find bugs early. It checks if you passe the right types of data to functions. For a big and complex project, that’s very valuable. It means we’ll get notified of lot of bugs, before shipping code to you.
+
+Anyway, if you don’t use TypeScript in your project, that’s fine. You’ll still be able to use tiptap and even get a really nice autocomplete for the tiptap API (if your editor supports it, but most do).
+
+If you’re using TypeScript in your project and want to extend tiptap, there are two things that are good to know.
 
 ## Options type
+To extend or create default options for an extension, you’ll need to define a custom type, here is an example:
 
+```js
+import { createExtension } from '@tiptap/core'
 
-## Create a command
+export interface CustomExtensionOptions {
+  awesomeness: number,
+}
 
+const CustomExtension = createExtension({
+  defaultOptions: <CustomExtensionOptions>{
+    awesomeness: 100,
+  },
+})
+```
+
+## Command type
+The core package also exports a `Command` type, which needs to be added to all commands that you specify in your code. Here is an example:
+
+```js
+import { Command, createExtension } from '@tiptap/core'
+
+const CustomExtension = createExtension({
+  addCommands() {
+    return {
+      /**
+       * Comments will be added to the autocomplete.
+       */
+      yourCommand: (): Command => ({ commands }) => {
+        // …
+      },
+    }
+  },
+})
+```
+
+That’s basically it. We’re doing all the rest automatically.
diff --git a/docs/src/layouts/App/base.scss b/docs/src/layouts/App/base.scss
index c666d4d9..0f0542b7 100644
--- a/docs/src/layouts/App/base.scss
+++ b/docs/src/layouts/App/base.scss
@@ -90,45 +90,45 @@ code {
   color: white;
 }
 
-.ProseMirror {
+// TODO: Move to examples
+// .ProseMirror {
+//   > * + * {
+//     margin-top: 0.75em;
+//   }
 
-  > * + * {
-    margin-top: 0.75em;
-  }
+//   ul,
+//   ol {
+//     padding: 0 1rem;
+//   }
 
-  ul,
-  ol {
-    padding: 0 1rem;
-  }
+//   pre {
+//     background: $colorBlack;
+//     color: $colorWhite;
+//     font-family: 'JetBrainsMono', monospace;
+//     padding: 0.75rem 1rem;
+//     border-radius: 0.5rem;
 
-  pre {
-    background: $colorBlack;
-    color: $colorWhite;
-    font-family: 'JetBrainsMono', monospace;
-    padding: 0.75rem 1rem;
-    border-radius: 0.5rem;
+//     code {
+//       color: inherit;
+//       background: none;
+//       font-size: 0.8rem;
+//     }
+//   }
 
-    code {
-      color: inherit;
-      background: none;
-      font-size: 0.8rem;
-    }
-  }
+//   img {
+//     max-width: 100%;
+//     height: auto;
+//   }
 
-  img {
-    max-width: 100%;
-    height: auto;
-  }
+//   hr {
+//     margin: 1rem 0;
+//   }
 
-  hr {
-    margin: 1rem 0;
-  }
-
-  blockquote {
-    padding-left: 1rem;
-    border-left: 2px solid rgba($colorBlack, 0.1);
-  }
-}
+//   blockquote {
+//     padding-left: 1rem;
+//     border-left: 2px solid rgba($colorBlack, 0.1);
+//   }
+// }
 
 .DocSearch {
   filter: saturate(0);
diff --git a/docs/src/links.yaml b/docs/src/links.yaml
index 8b8473fb..28277793 100644
--- a/docs/src/links.yaml
+++ b/docs/src/links.yaml
@@ -62,7 +62,6 @@
       draft: true
     - title: Working with TypeScript
       link: /guide/working-with-typescript
-      draft: true
 
 - title: API
   items: