CodeSandBox/monaco-editor-lsp-next
2
0
Fork 0
mirror of https://github.com/cfngc4594/monaco-editor-lsp-next.git synced 2025-05-18 15:26:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(readme): improve setup instructions with pre-built Docker images

Browse Source
This commit is contained in:
cfngc4594 2025-03-05 16:19:02 +08:00
parent 3e94bf07a6
commit 4e1a185036
1 changed files with 30 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -26,29 +26,46 @@ Complete these steps before launching the editor for seamless LSP integration!
### 🐳 Docker Deployment (Recommended) ### 🐳 Docker Deployment (Recommended)
Deploy the project quickly using pre-built Docker images:
```sh ```sh
# Clone repository # Clone the repository
git clone https://github.com/cfngc4594/monaco-editor-lsp-next git clone https://github.com/cfngc4594/monaco-editor-lsp-next
cd monaco-editor-lsp-next cd monaco-editor-lsp-next
# Build and launch containers # Start the application with pre-built images
docker compose up -d --build docker compose up -d
``` ```
### 🔨 Manual Installation ### 🔨 Local Manual Build
Build the images locally and start the containers:
```sh ```sh
# Clone repository # Clone the repository
git clone https://github.com/cfngc4594/monaco-editor-lsp-next git clone https://github.com/cfngc4594/monaco-editor-lsp-next
cd monaco-editor-lsp-next cd monaco-editor-lsp-next
# Start core LSP containers # Build and start containers using the local configuration
docker compose up -d --build lsp-c lsp-cpp docker compose -f compose.local.yml up -d --build
```
# Install dependencies (using Bun) ### 🛠 Development Mode
Set up a development environment with hot-reloading:
```sh
# Clone the repository
git clone https://github.com/cfngc4594/monaco-editor-lsp-next
cd monaco-editor-lsp-next
# Start only the LSP containers
docker compose up -d lsp-c lsp-cpp
# Or use the local configuration
# docker compose -f compose.local.yml up -d --build lsp-c lsp-cpp
# Install dependencies and start the development server
bun install bun install
# Launch development server
bun run dev bun run dev
``` ```
@ -97,10 +114,12 @@ bun run dev
Syntax highlighting depends on `rehype-pretty-code`'s deprecated `getHighlighter` API from `shiki@legacy`. Syntax highlighting depends on `rehype-pretty-code`'s deprecated `getHighlighter` API from `shiki@legacy`.
**Key Points**: **Key Points**:
- **Affected File:** `src/components/mdx-preview.tsx` - **Affected File:** `src/components/mdx-preview.tsx`
- **Dependency Chain:** `rehype-pretty-code` → `shiki@legacy` - **Dependency Chain:** `rehype-pretty-code` → `shiki@legacy`
- **Version Constraints**: - **Version Constraints**:
```bash
```sh
"shiki": "<=2.5.0" "shiki": "<=2.5.0"
"@shikijs/monaco": "<=2.5.0" "@shikijs/monaco": "<=2.5.0"
``` ```