Skip to content

docs(codeSnippet): update title and description for consistency #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 25, 2024
Merged

docs(codeSnippet): update title and description for consistency #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/components/codeSnippet/codeSnippet.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ import React from 'react'

import CodeSnippet from './codeSnippet'
export default {
title: 'Rustic UI/CodeSnippet/CodeSnippet',
title: 'Rustic UI/Code Snippet/Code Snippet',
component: CodeSnippet,
tags: ['autodocs'],
parameters: {
layout: 'centered',
docs: {
description: {
component: `The CodeSnippet component, powered by [CodeMirror](https://codemirror.net/), enables the display of code blocks with syntax highlighting for various programming languages.
component: `The \`CodeSnippet\` component, powered by [CodeMirror](https://codemirror.net/), enables the display of code blocks with syntax highlighting for various programming languages.
For further customization of the component's theme, refer to the [styling guide](https://codemirror.net/examples/styling/) provided by the CodeMirror library.
\nNote: CodeMirror libraries are not bundled, so they must be included in the application's build process. Please install the following codemirror dependencies if you want to use CodeSnippet component in your project:
\n<pre><code>npm i @codemirror/language @codemirror/language-data @codemirror/state @codemirror/theme-one-dark @codemirror/view </code></pre>`,
Expand Down