Upgrade Algolia, Nuxt, and DocSearch + Module Refactor and New Features #240
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Translated various sections of the DocSearch examples from Italian to English for better accessibility. - Updated example descriptions and placeholders to reflect the new translations. - Enhanced user experience by providing clearer instructions and descriptions in the examples. - Improved code comments and documentation for better understanding of functionalities.
- Removed environment variable dependencies in nuxt.config.ts for Algolia DocSearch configuration. - Re-exported types from algoliasearch in types.ts, streamlining type management. - Enhanced AlgoliaDocSearch.vue to ensure unique container IDs are generated on the client side, improving SSR compatibility. - Added fallback mechanisms for container ID selection to prevent errors during initialization.
- Simplified nuxt.config.ts by removing unused modules and adding essential ones for content management and image optimization. - Introduced a new AppHeaderLogo component for improved branding in the application header. - Reorganized documentation structure by replacing outdated index files and enhancing content with clearer descriptions and navigation. - Added new markdown files for getting started, installation, and project structure to facilitate user onboarding. - Updated package.json to include necessary dependencies and scripts for development and production builds.
- Deleted .eslintignore and .eslintrc files to streamline project configuration. - Updated build.config.ts to include '@docsearch/react' in the dependencies. - Enhanced eslint.config.mjs by appending custom rules for Vue component naming. - Added @nuxt/eslint-config as a development dependency in package.json. - Made minor adjustments to various files for consistency and improved readability.
- Removed the "type" field from package.json for cleaner configuration. - Updated type definitions in types.ts to use 'unknown' instead of 'any' for better type safety. - Refactored crawler.ts to simplify the Algolia client initialization and batch object handling. - Enhanced AlgoliaDocSearch.vue for improved readability and maintainability by restructuring conditional logic. - Cleaned up useAlgoliaInitIndex.ts by removing unnecessary type exports.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Types of changes
Description
This PR introduces a major update of the Algolia/Nuxt stack along with a comprehensive refactor of the Algolia module.
Specifically:
These changes improve compatibility with the latest dependency versions, enhance code maintainability, and provide greater flexibility when integrating DocSearch in more advanced use cases (e.g. complex layouts or multi-search scenarios).
Checklist: