/ScriptSheets

An open-source project that provides a structured collection of notes and cheat sheets for various programming languages and technologies.

Primary LanguageJavaScriptMIT LicenseMIT

ScriptSheets - Cheat Sheet for Developers

ScriptSheets is an open-source project that provides a structured collection of notes and cheat sheets for various programming languages and technologies. It helps developers quickly access key concepts, syntax, and examples.

Features

  • 📌 Notes and cheat sheets for multiple programming languages and frameworks.
  • 🌙 Light/Dark mode toggle.
  • 📖 Markdown support with syntax highlighting using rehype-highlight.
  • 🔗 External links to official documentation.

Technologies Used

  • React with Vite for fast development.
  • React Router for page navigation.
  • react-markdown for rendering Markdown content.
  • rehype-highlight for syntax highlighting.
  • CSS for styling.

Installation

  1. Clone the repository:
    git clone https://github.com/EIC95/CheatSheet.git
  2. Navigate into the project directory:
    cd CheatSheet
  3. Install dependencies:
    npm install
  4. Start the development server:
    npm run dev
  5. Open the project in your browser (usually at http://localhost:5173).

Project Structure

/
├── public/            # Contains Markdown files for each technology
├── assets/            # Icons for languages and other images
├── src/
│   ├── components/    # Reusable components (Sidebar, Content, Navbar, etc.)
│   ├── style.css      # Global styles
│   ├── App.jsx        # Main app component
│   ├── main.jsx       # Entry point
│
└── README.md          # This file

Contributing

We welcome contributions! Please check out our Contribution Guide to get started.

License

This project is licensed under the MIT License – you are free to use, modify, and distribute it as long as the license is included.

Acknowledgments

Inspired by JavaScript Cheat Sheet.
Made with ❤️ by eic.codes.