GarudaNvim Website - garudanvim.github.io

Welcome to the GarudaNvim website repository! This repository hosts the documentation and website for GarudaNvim, a custom Neovim configuration designed to enhance your coding experience on macOS. The website provides users with comprehensive guides, features, and installation instructions.

Table of Contents

• Project Overview
• Features
• Installation
• Usage
• Contributing
• License

Project Overview

GarudaNvim is a Neovim configuration that aims to provide a user-friendly and efficient coding environment. The configuration includes numerous enhancements, keymaps, and plugins tailored to improve workflow and productivity for developers.

This repository serves as the online documentation and resource hub for users to easily access information about GarudaNvim.

Features

• Comprehensive Documentation: Detailed guides on installation, configuration, and usage.
• Keymaps Page: Extensive information on keybindings to enhance navigation and productivity.
• Installation Instructions: Step-by-step instructions to get GarudaNvim up and running quickly.
• Dark Mode Support: A modern and visually appealing theme with dark mode toggle for comfortable coding at any time.
• Search Functionality: Easily find the information you need with a built-in search feature.
• Built with MkDocs Material: The website leverages the MkDocs Material theme, known for its elegant design and user-friendly navigation, ensuring a seamless experience for users.

Installation

To set up the GarudaNvim website locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/GarudaNvim/GarudaNvim.github.io.git
   cd GarudaNvim.github.io

2. Install the dependencies: Make sure you have Python installed, and then run:

   pip install mkdocs mkdocs-material

3. Run the development server:

   mkdocs serve

   Open your browser and navigate to http://127.0.0.1:8000 to view the website locally.

Usage

The GarudaNvim website provides a wealth of information. Here are some of the main sections:

• Home: An introduction to GarudaNvim and its purpose.
• Features: A detailed list of what GarudaNvim offers.
• Installation: Step-by-step guidance for installing GarudaNvim.
• Configuration: Tips and tricks for customizing your Neovim setup.
• Keymaps: A detailed list of keybindings for enhanced navigation and productivity.
• Themes: Options and configurations for customizing the appearance of Neovim.

Contributing

Contributions are welcome! If you have suggestions or improvements, please feel free to open an issue or submit a pull request. Here are some ways you can contribute:

• Improve the documentation by correcting typos or adding new content.
• Suggest new features or enhancements for GarudaNvim.
• Help with bug fixes or other issues.

Guidelines

• Follow the existing style and structure of the documentation.
• Clearly explain any changes or additions you make in your pull request.

License

This project is licensed under the GPL-3.0 License. See the LICENSE file for details.