diff --git a/.storybook/main.ts:Zone.Identifier b/.storybook/main.ts:Zone.Identifier deleted file mode 100644 index e69de29..0000000 diff --git a/.storybook/preview.ts:Zone.Identifier b/.storybook/preview.ts:Zone.Identifier deleted file mode 100644 index e69de29..0000000 diff --git a/.yarn/install-state.gz:Zone.Identifier b/.yarn/install-state.gz:Zone.Identifier deleted file mode 100644 index e69de29..0000000 diff --git a/public/vite.svg:Zone.Identifier b/public/vite.svg:Zone.Identifier deleted file mode 100644 index e69de29..0000000 diff --git a/src/stories/Configure.mdx b/src/stories/Configure.mdx index 5157090..a714f14 100644 --- a/src/stories/Configure.mdx +++ b/src/stories/Configure.mdx @@ -1,208 +1,147 @@ -import { Meta } from "@storybook/blocks"; - -import Github from "./assets/github.svg"; -import Discord from "./assets/discord.svg"; -import Youtube from "./assets/youtube.svg"; -import Tutorials from "./assets/tutorials.svg"; -import Styling from "./assets/styling.png"; -import Context from "./assets/context.png"; -import Assets from "./assets/assets.png"; -import Docs from "./assets/docs.png"; -import Share from "./assets/share.png"; -import FigmaPlugin from "./assets/figma-plugin.png"; -import Testing from "./assets/testing.png"; -import Accessibility from "./assets/accessibility.png"; -import Theming from "./assets/theming.png"; -import AddonLibrary from "./assets/addon-library.png"; - -export const RightArrow = () => ( + - - + > + + +) - +
- # Configure your project + # Configure React NES Components + + Welcome to React NES Components! This guide will help you set up and configure the components in your project. Below, you'll find essential information about styling, theming, and integration with your application. - Because Storybook works separately from your app, you'll need to configure it for your specific stack and setup. Below, explore guides for configuring Storybook with popular frameworks and tools. If you get stuck, learn how you can ask for help from our community.
A wall of logos representing different styling technologies -

Add styling and CSS

-

Like with web applications, there are many ways to include CSS within Storybook. Learn more about setting up styling within Storybook.

+

NES-Style Styling

+

Learn how to customize the retro NES look and feel of your components. From pixel-perfect borders to authentic color palettes, make your UI truly nostalgic.

Learn more
An abstraction representing the composition of data for a component -

Provide context and mocking

-

Often when a story doesn't render, it's because your component is expecting a specific environment or context (like a theme provider) to be available.

+

Component Context

+

Understand how to properly integrate NES components with your React application's context providers and state management.

Learn more
- A representation of typography and image assets + NES-style assets and resources
-

Load assets and resources

-

To link static files (like fonts) to your projects and stories, use the - `staticDirs` configuration option to specify folders to load when - starting Storybook.

+

Assets and Resources

+

Access and customize the pixel art assets, fonts, and other resources that make your NES components authentic.

Learn more
+
- # Do more with Storybook + # Advanced Features + + Take your NES components to the next level with these advanced features and integrations. - Now that you know the basics, let's explore other parts of Storybook that will improve your experience. This list is just to get you started. You can customise Storybook in many ways to fit your needs.
- A screenshot showing the autodocs tag being set, pointing a docs page being generated -

Autodocs

-

Auto-generate living, - interactive reference documentation from your components and stories.

- Learn more -
-
- A browser window showing a Storybook being published to a chromatic.com URL -

Publish to Chromatic

-

Publish your Storybook to review and collaborate with your entire team.

- Learn more -
-
- Windows showing the Storybook plugin in Figma -

Figma Plugin

-

Embed your stories into Figma to cross-reference the design and live - implementation in one place.

+ Component documentation +

Component Documentation

+

Explore detailed documentation for each NES component, including props, examples, and usage guidelines.

Learn more
- Screenshot of tests passing and failing + Testing NES components

Testing

-

Use stories to test a component in all its variations, no matter how - complex.

+

Learn how to write effective tests for your NES components, ensuring they work perfectly in all scenarios.

Learn more
- Screenshot of accessibility tests passing and failing + Accessibility considerations

Accessibility

-

Automatically test your components for a11y issues as you develop.

+

Make your NES components accessible while maintaining their retro aesthetic.

Learn more
- Screenshot of Storybook in light and dark mode -

Theming

-

Theme Storybook's UI to personalize it to your project.

+ Custom theming options +

Custom Theming

+

Create custom themes for your NES components while preserving their authentic look and feel.

Learn more
-
-
-

Addons

-

Integrate your tools with Storybook to connect workflows.

- Discover all addons -
-
- Integrate your tools with Storybook to connect workflows. -
-
Github logo - Join our contributors building the future of UI development. + Contribute to the React NES Components project. Star on GitHub
-
- Discord logo -
- Get support and chat with frontend developers. - Join Discord server -
-
-
- Youtube logo -
- Watch tutorials, feature previews and interviews. - - Watch on YouTube -
-
-
- A book -

Follow guided walkthroughs on for key workflows.

- - Discover tutorials -