Skip to content

Commit

Permalink
chore: updated readme [skip-release]
Browse files Browse the repository at this point in the history
  • Loading branch information
freb97 committed Aug 19, 2024
1 parent 41d4323 commit f91f4f0
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<details>
<summary>Headings</summary>
Custom heading tags (`<h1>`, `<h2>`, `<h3>`, etc.):
Expand All @@ -139,8 +140,10 @@ Custom heading tags (`<h1>`, `<h2>`, `<h3>`, etc.):
```
This pattern also extends to the `h3`, `h4`, `h5` and `h6` tags.
</details>
##### Lists
<details>
<summary>Lists</summary>
Custom list tags (`<ol>`, `<ul>` and `<li>`):
Expand All @@ -166,8 +169,10 @@ Custom list tags (`<ol>`, `<ul>` and `<li>`):
</li>
</template>
```
</details>
##### Blockquotes and Codes
<details>
<summary>Blockquotes and Codes</summary>
Custom blockquote and code tags (`<blockquote>`, `<pre>`):
Expand All @@ -184,8 +189,10 @@ Custom blockquote and code tags (`<blockquote>`, `<pre>`):
<pre class="my-custom-class-for-pre"><slot /></pre>
</template>
```
</details>
##### Inline text nodes
<details>
<summary>Inline text nodes</summary>
Custom inline text nodes (`<strong>`, `<em>`, `<u>`, `<del>`, `<code>`):
Expand Down Expand Up @@ -225,8 +232,10 @@ Custom inline text nodes (`<strong>`, `<em>`, `<u>`, `<del>`, `<code>`):
</code>
</template>
```
</details>
##### Links
<details>
<summary>Links</summary>
Custom link tag (`<a>`):
Expand All @@ -246,8 +255,10 @@ Custom link tag (`<a>`):
```
When rendering a link tag, the url gets passed as the `url` component property.
</details>
##### Images
<details>
<summary>Images</summary>
Custom image tag (`<img>`):
Expand All @@ -272,6 +283,7 @@ Custom image tag (`<img>`):
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.
</details>
## Development
Expand Down

0 comments on commit f91f4f0

Please sign in to comment.