monaco-editor-lsp-next/README.md

66 lines
1.6 KiB
Markdown
Raw Normal View History

<div align="center">
# monaco-editor-lsp-next
2025-02-19 01:00:15 +00:00
✨ A Next.js integration of Monaco Editor with LSP support, free from SSR issues.
![demo](demo.png)
</div>
## ⚠️ Important Notice for WSL Users!
If you're using Windows Subsystem for Linux (WSL), it's **crucial** to switch your network mode to "Mirrored".
Otherwise, the Monaco Editor might fail to connect to the LSP language servers.
This is typically due to IPv6 configuration issues.
To change your WSL network mode, follow these steps:
1. Open WSL settings. ⚙️
2. Navigate to the "Network" section. 🌐
3. Change the network mode to "Mirrored". 🔄
4. Restart WSL. 💻
After completing these steps, the Monaco Editor should be able to connect to the LSP language servers without any problems. 🎉
## 🚀 Quick Start
### 🐳 Using Docker (Recommended)
2025-02-19 01:00:15 +00:00
```sh
# Clone repository
git clone https://github.com/cfngc4594/monaco-editor-lsp-next
cd monaco-editor-lsp-next
2025-02-19 01:00:15 +00:00
# Start containers in detached mode
docker compose up -d
```
2025-02-19 01:00:15 +00:00
### 🔧 Manual Setup
2025-02-19 01:00:15 +00:00
```sh
# Clone repository
git clone https://github.com/cfngc4594/monaco-editor-lsp-next
cd monaco-editor-lsp-next
# Start specific containers (lsp-c and lsp-cpp) in detached mode
docker compose up -d lsp-c lsp-cpp
# Install project dependencies using Bun package manager
bun install
# Run the development server
bun run dev
```
2025-02-19 01:00:15 +00:00
## ⚙️ Configuration
2025-02-19 01:00:15 +00:00
### LSP Server Settings
2025-02-19 01:00:15 +00:00
| **Language** | **LSP Server** | **Port** |
|----------------|------------------|------------|
| `C` | `clangd` | `4594` |
| `C++` | `clangd` | `4595` |