Welcome to the official documentation for the monaco-languageclient. The monaco-languageclient library provides the ability to integrate the Monaco Editor with language clients and language servers utilizing the Language Server Protocol (LSP). Using the monaco-languageclient, you can build purely web-based editors with full LSP support, enabling features like code completion, diagnostics, and more.
This documentation is built to help newcomers and experts to be able to quickly leverage the monaco-languageclient effectively.
In particular, the monaco-languageclient is helpful when you need to:
- Integrate language server features into web applications using the Monaco Editor.
- Build custom language support for specific programming languages in a web-based environment.
- Utilize WebSocket or Web Worker connections to communicate with language servers deployed elsewhere.
We've split up the documentation into sections that cover a variety of topics, starting at an introduction, and later getting into specific guides:
- Introduction: Learn what the
monaco-languageclientis, its key concepts, and how it works. - Installation: Step-by-step instructions to get started with
monaco-languageclient, including dependencies and setup. - Guides: General overview of all guides.
- Getting Started: Walking through your first monaco language client integration.
- Configuration: Basic configuration options.
- Examples: Simple examples to illustrate common use cases.
- Troubleshooting: Common issues and solutions.
- Migration: Migration between versions. Staring from version 9 to 10.
- Versions and History: Information on version compatibility and historical changes.