Skip to content

Dksie09/retroui-docs

Repository files navigation

Retro UI Documentation

Welcome to the documentation repository for Retro UI, a pixelated UI library for React applications. This repository contains the source code for our documentation website built with Next.js.

Repository Structure

Key folders and their purposes:

.
├── app/                    # Next.js 13+ app directory
│   ├── components/         # Shared components for the docs site
│   └── ...                 # Individual component documentation pages
├── public/                 # Static assets
└── ...                     # Configuration files

Getting Started

Prerequisites

  • Node.js (v14 or later)
  • npm

Installation

  1. Clone the repository:

    git clone https://github.com/Dksie09/retroui-docs
    cd retroui-docs
  2. Install dependencies:

    npm install
  3. Run the development server:

    npm run dev
  4. Open http://localhost:3000 in your browser to view the documentation site.

Contributing

We welcome contributions to improve our documentation! Please open an issue, get assigned, fork the repository, make your changes, and submit a pull request.

Support

If you encounter any issues or have questions, please open an issue on this repository.

Thank you for contributing to Retro UI documentation!

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages