Skip to content

Commit

Permalink
chore(docs): Add missing prop documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AVGVSTVS96 committed Aug 8, 2024
1 parent 9b6cd72 commit 4b1c7ef
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
3 changes: 2 additions & 1 deletion package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,10 @@ function CodeBlock() {
The component accepts several props in addition to language and theme:

- `showLanguage: boolean` - Shows the language name in the top right corner of the code block.
- `style: object` - Style object to be passed to the component.
- `addDefaultStyles: boolean` - Adds default styles to the code block.
- `as: string` - The component to be rendered. Defaults to 'pre'.
- `className: string` - Class name to be passed to the component.
- `style: object` - Style object to be passed to the component.

```tsx
function Houston() {
Expand Down
8 changes: 6 additions & 2 deletions playground/src/CodeTest.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -330,8 +330,8 @@ export const HighlightCodeBlocks = React.memo(() => {
the top right corner of the code block.
</li>
<li>
<code>style: object</code> - Style object to be passed to the
component.
<code>addDefaultStyles: boolean</code> - Adds default styles to
the top right corner of the code block.
</li>
<li>
<code>as: string</code> - The component to be rendered. Defaults
Expand All @@ -341,6 +341,10 @@ export const HighlightCodeBlocks = React.memo(() => {
<code>className: string</code> - Class name to be passed to the
component.
</li>
<li>
<code>style: object</code> - Style object to be passed to the
component.
</li>
</ul>
<Houston />
<p>
Expand Down

0 comments on commit 4b1c7ef

Please sign in to comment.