-
Notifications
You must be signed in to change notification settings - Fork 2
Add search bar and minor github/contributing improvements #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…into minor-tweaks
…adDocs into minor-tweaks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a search bar to the website, fixes some theme issues, and enhances the project with documentation and configuration files. The changes primarily focus on improving code documentation formatting and establishing proper project setup.
- Adds local search functionality to the VitePress configuration
- Creates README.md and CONTRIBUTING.md files for better project documentation
- Standardizes heading formatting across documentation files by changing from
###to##for section headers - Adds theme improvements with better comments and search configuration
- Includes configuration files for code formatting and linting
Reviewed Changes
Copilot reviewed 25 out of 35 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| .vitepress/config.mts | Adds local search provider configuration |
| .vitepress/theme/custom.css | Improves CSS comments for better code documentation |
| README.md | Creates project README with basic information and technology stack |
| CONTRIBUTING.md | Establishes comprehensive contributing guidelines and requirements |
| .prettierrc.json | Adds Prettier configuration for consistent code formatting |
| .markdownlint.json | Configures markdown linting rules |
| Multiple .md files | Standardizes heading hierarchy and fixes formatting issues |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Currently adds a search bar, fixes some theme issues, and adds a readme and contributing file