Skip to content

thenfks/fkthemes-nvim

Repository files navigation

🎨 Fkthemes Website

A modern website showcasing the fkthemes.nvim plugin, featuring an interactive demo, comprehensive documentation, and a sleek user interface.

✨ Features

  • Interactive Theme Demo: Experience real-time theme switching directly in your browser.
  • Comprehensive Documentation: Detailed guides on installation, configuration, commands, and API reference for fkthemes.nvim.
  • Dynamic UI: Built with React, Vite, and Tailwind CSS for a fast and responsive user experience.
  • Shadcn UI Components: Utilizes a beautiful and accessible component library.
  • Notification System: Provides visual and auditory feedback for theme changes.

🚀 Technologies Used

  • Frontend: React, TypeScript, Vite
  • Styling: Tailwind CSS, Shadcn UI
  • Routing: React Router DOM
  • State Management: React Context API
  • Notifications: Sonner
  • Audio Playback: Howler.js
  • Syntax Highlighting: React Syntax Highlighter

📦 Installation

To set up and run this project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/flashcodes-themayankjha/Fkthemes-website.git
    cd Fkthemes-website
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev

    The application will be accessible at http://localhost:5173 (or another port if 5173 is in use).

💡 Usage

  • Home Page: Provides an overview of the fkthemes.nvim project.
  • Docs Page: Contains detailed documentation for the fkthemes.nvim plugin.
    • Navigate through sections using the left sidebar.
    • Use the theme selector in the sidebar to change the website's theme.
    • The right sidebar provides a table of contents for the current section.
  • Interactive Demo Page: A dedicated page to interactively test theme switching.

🤝 Contributing

Contributions are welcome! If you have suggestions, bug reports, or want to contribute code, please feel free to open an issue or submit a pull request.

📜 License

This project is licensed under the MIT License.

Releases

No releases published

Packages

 
 
 

Contributors

Languages