From f91f4f0a4278f02914008b23e6db60661183cc67 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frederik=20Bu=C3=9Fmann?= Date: Mon, 19 Aug 2024 21:23:41 +0200 Subject: [PATCH] chore: updated readme [skip-release] --- README.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9d2c98e..b5bf1dd 100644 --- a/README.md +++ b/README.md @@ -116,9 +116,10 @@ paragraph node component would be named `MyCustomBlocksPrefixParagraphNode`. #### Other Custom Tags -You can apply similar customizations to all other HTML tags used by the renderer. +You can apply similar customizations to all other HTML tags used by the renderer: -##### Headings +
+Headings Custom heading tags (`

`, `

`, `

`, etc.): @@ -139,8 +140,10 @@ Custom heading tags (`

`, `

`, `

`, etc.): ``` This pattern also extends to the `h3`, `h4`, `h5` and `h6` tags. +

-##### Lists +
+Lists Custom list tags (`
    `, `
      ` and `
    • `): @@ -166,8 +169,10 @@ Custom list tags (`
        `, `
          ` and `
        • `):
        • ``` +
-##### Blockquotes and Codes +
+Blockquotes and Codes Custom blockquote and code tags (`
`, `
`):
 
@@ -184,8 +189,10 @@ Custom blockquote and code tags (`
`, `
`):
     
``` +
-##### Inline text nodes +
+Inline text nodes Custom inline text nodes (``, ``, ``, ``, ``): @@ -225,8 +232,10 @@ Custom inline text nodes (``, ``, ``, ``, ``): ``` +
-##### Links +
+Links Custom link tag (``): @@ -246,8 +255,10 @@ Custom link tag (``): ``` When rendering a link tag, the url gets passed as the `url` component property. +
-##### Images +
+Images Custom image tag (``): @@ -272,6 +283,7 @@ Custom image tag (``): When rendering an image tag, the image object gets passed as the `image` component property. You can also use different image components here, i.e. `NuxtImg` or others. +
## Development