# OverKeys Documentation

Welcome to the OverKeys documentation! This guide will help you get started with OverKeys, a customizable, open-source on-screen keyboard visualizer for alternative layouts.

## Getting Started

- [Installation](getting-started/installation.md) - Install and set up OverKeys on your Windows machine
- [Basic Usage](getting-started/basic-usage.md) - Learn how to use OverKeys's core features

## User Guide

- [Preferences](user-guide/preferences.md) - Configure OverKeys to match your needs
- [Learning Mode](user-guide/learning-mode.md) - Use the specialized color scheme for learning new layouts
- [Supported Layouts](../README.md#features) - View the list of built-in keyboard layouts

## Advanced Features

- [Custom Font](advanced/custom-font.md) - Use a system-installed font not found in the dropdown
- [Custom Layouts](advanced/custom-layouts.md) - Create and use your own keyboard layouts
- [Alternative Layout Toggle](advanced/alternative-layouts.md) - Quickly switch between different layouts
- [6-Column Layouts](advanced/6-column-layouts.md) - Set up OverKeys for a 6-column split matrix keyboard
- [Layer Switching](advanced/layer-switching.md) - Switch between multiple custom keyboard layers with custom triggers
- [Kanata Integration](advanced/kanata-integration.md) - Connect OverKeys with Kanata for advanced functionality
- [Shift Mappings](advanced/shift-mappings.md) - Customize shift-key behavior for specific characters
- [Supported Keys Reference](advanced/supported-keys.md) - Complete list of keys you can use in custom layouts

## Additional Resources

- [Project README](../README.md) - Overview of the project
- [Changelog](../CHANGELOG.md) - Release history and features
- [GitHub Repository](https://github.com/conventoangelo/OverKeys) - Source code and issue tracking

## Common Tasks

- [Creating a custom layout](advanced/custom-layouts.md#creating-custom-layouts)
- [Setting up alternative layout switching](advanced/alternative-layouts.md)
- [Finding key names for custom layouts](advanced/supported-keys.md)
- [Troubleshooting custom layouts](advanced/custom-layouts.md#troubleshooting)

## Support

If you encounter any issues or have questions, please visit the [GitHub Discussions](https://github.com/conventoangelo/OverKeys/discussions) page or [report a bug](https://github.com/conventoangelo/OverKeys/issues/new?template=bug_report.md).