Skip to content

docs: sync English installation documentation from Chinese version #158

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

Merged
merged 2 commits into from
Aug 19, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 19, 2025

The English installation documentation was outdated and missing several important features compared to the Chinese version. This PR synchronizes the English documentation to match the comprehensive Chinese installation guide.

Key Changes

Updated Installation Instructions

  • Global Installation: Now includes all required dependencies (nextui-vue tailwindcss @heroui/theme) instead of just nextui-vue
  • Added explanatory text that nextui-vue doesn't bundle the @heroui/theme dependency and requires TailwindCSS to be installed together

Comprehensive Configuration Section

  • Replaced the basic "Theme Configuration" with a full "Configuration" section
  • TailwindCSS Version Support: Updated from "V3 and below only" to "V4 by default with limited V3 support"
  • Two Configuration Approaches: Added support for both with and without tailwind.config.js file configurations

TailwindCSS V4 Support

  • Updated import syntax from require('@heroui/theme') to ES modules import { heroui } from '@heroui/theme'
  • Added new TailwindCSS V4 configuration method using @import, @source, @plugin, and @custom-variant directives
  • Included detailed explanation of why tailwind.config.js is recommended with benefits like reduced migration cost and better compatibility

New Vite Configuration Section

  • Added complete Vite setup instructions including plugin installation (@tailwindcss/vite)
  • Provided step-by-step configuration for vite.config.ts

Content Structure

The English documentation now mirrors the Chinese version's structure:

  1. Global Installation - Complete dependency installation
  2. On-Demand Installation - Component-specific installation with configuration prerequisites
  3. Configuration - Comprehensive TailwindCSS and Vite setup
    • TailwindCSS (with/without config file approaches)
    • Vite plugin configuration

Before this change, users following the English documentation would encounter issues due to missing dependencies and outdated configuration instructions. The documentation now provides clear, up-to-date installation paths for both TailwindCSS V3 and V4 users.

Fixes #157.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copy link

vercel bot commented Aug 19, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
nextui-vue-docs Ready Ready Preview Comment Aug 19, 2025 7:16am

Co-authored-by: hotdogc1017 <126151508+hotdogc1017@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Sync https://nextui.hotdogc.org/en/guide/installation.html from https://nextui.hotdogc.org/zh/guide/installation.html docs: sync English installation documentation from Chinese version Aug 19, 2025
@Copilot Copilot AI requested a review from hotdogc1017 August 19, 2025 07:18
Copilot finished work on behalf of hotdogc1017 August 19, 2025 07:18
@hotdogc1017 hotdogc1017 marked this pull request as ready for review August 19, 2025 07:19
@hotdogc1017 hotdogc1017 merged commit 7cee9d2 into main Aug 19, 2025
3 checks passed
@hotdogc1017 hotdogc1017 deleted the copilot/fix-157 branch August 19, 2025 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sync https://nextui.hotdogc.org/en/guide/installation.html from https://nextui.hotdogc.org/zh/guide/installation.html
2 participants