You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
monaco-editor/README.md

97 lines
5.2 KiB
Markdown

9 years ago
# Monaco Editor
[![Build Status](https://dev.azure.com/ms/monaco-editor/_apis/build/status/microsoft.monaco-editor?label=website)](https://dev.azure.com/ms/monaco-editor/_build/latest?definitionId=3)
The Monaco Editor is the code editor which powers [VS Code](https://github.com/Microsoft/vscode), with the features better described [here](https://code.visualstudio.com/docs/editor/editingevolved).
9 years ago
Please note that this repository contains no source code for the code editor, it only contains the scripts to package everything together and ship the `monaco-editor` npm module.
![image](https://user-images.githubusercontent.com/5047891/94183711-290c0780-fea3-11ea-90e3-c88ff9d21bd6.png)
9 years ago
## Try it out
6 years ago
Try the editor out [on our website](https://microsoft.github.io/monaco-editor/index.html).
9 years ago
## Installing
```
$ npm install monaco-editor
9 years ago
```
You will get:
* inside `esm`: ESM version of the editor (compatible with e.g. webpack)
* inside `dev`: AMD bundled, not minified
* inside `min`: AMD bundled, and minified
9 years ago
* inside `min-maps`: source maps for `min`
* `monaco.d.ts`: this specifies the API of the editor (this is what is actually versioned, everything else is considered private and might break with any release).
It is recommended to develop against the `dev` version, and in production to use the `min` version.
## Documentation
9 years ago
* Learn how to integrate the editor with these [complete samples](https://github.com/Microsoft/monaco-editor-samples/).
* [Integrate the AMD version](./monaco-editor/docs/integrate-amd.md).
* [Integrate the AMD version cross-domain](./monaco-editor/docs/integrate-amd-cross.md)
* [Integrate the ESM version](./monaco-editor/docs/integrate-esm.md)
* Learn how to use the editor API and try out your own customizations in the [playground](https://microsoft.github.io/monaco-editor/playground.html).
* Explore the [API docs](https://microsoft.github.io/monaco-editor/api/index.html) or read them straight from [`monaco.d.ts`](https://github.com/Microsoft/monaco-editor/blob/master/website/playground/monaco.d.ts.txt).
* Read [this guide](https://github.com/Microsoft/monaco-editor/wiki/Accessibility-Guide-for-Integrators) to ensure the editor is accessible to all your users!
* Create a Monarch tokenizer for a new programming language [in the Monarch playground](https://microsoft.github.io/monaco-editor/monarch.html).
* Ask questions on [StackOverflow](https://stackoverflow.com/questions/tagged/monaco-editor)! Search open and closed issues, there are a lot of tips in there!
9 years ago
## Issues
9 years ago
Create [issues](https://github.com/Microsoft/monaco-editor/issues) in this repository for anything related to the Monaco Editor. Always mention **the version** of the editor when creating issues and **the browser** you're having trouble in. Please search for existing issues to avoid duplicates.
8 years ago
9 years ago
## FAQ
8 years ago
**What is the relationship between VS Code and the Monaco Editor?**
9 years ago
8 years ago
The Monaco Editor is generated straight from VS Code's sources with some shims around services the code needs to make it run in a web browser outside of its home.
9 years ago
8 years ago
**What is the relationship between VS Code's version and the Monaco Editor's version?**
9 years ago
8 years ago
None. The Monaco Editor is a library and it reflects directly the source code.
9 years ago
8 years ago
**I've written an extension for VS Code, will it work on the Monaco Editor in a browser?**
9 years ago
7 years ago
No.
> Note: If the extension is fully based on the [LSP](https://microsoft.github.io/language-server-protocol/) and if the language server is authored in JavaScript, then it would be possible.
9 years ago
8 years ago
**Why all these web workers and why should I care?**
9 years ago
6 years ago
Language services create web workers to compute heavy stuff outside of the UI thread. They cost hardly anything in terms of resource overhead and you shouldn't worry too much about them, as long as you get them to work (see above the cross-domain case).
9 years ago
8 years ago
**What is this `loader.js`? Can I use `require.js`?**
9 years ago
8 years ago
It is an AMD loader that we use in VS Code. Yes.
9 years ago
8 years ago
**I see the warning "Could not create web worker". What should I do?**
9 years ago
6 years ago
HTML5 does not allow pages loaded on `file://` to create web workers. Please load the editor with a web server on `http://` or `https://` schemes. Please also see the cross-domain case above.
9 years ago
8 years ago
**Is the editor supported in mobile browsers or mobile web app frameworks?**
8 years ago
No.
8 years ago
**Why doesn't the editor support TextMate grammars?**
9 years ago
* Please see https://github.com/bolinfest/monaco-tm which puts together `monaco-editor`, `vscode-oniguruma` and `vscode-textmate` to get TM grammar support in the editor.
**What about IE 11 support?**
* The Monaco Editor no longer supports IE 11. The last version that was tested on IE 11 is `0.18.1`.
8 years ago
## Development setup
9 years ago
8 years ago
Please see [CONTRIBUTING](./CONTRIBUTING.md)
9 years ago
9 years ago
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
9 years ago
9 years ago
## License
Licensed under the [MIT](https://github.com/Microsoft/monaco-editor/blob/master/LICENSE.md) License.