monaco-editor:基于浏览器的代码编辑器_html/css

Home

Web Front-end

HTML Tutorial

monaco-editor:基于浏览器的代码编辑器_html/css_WEB-ITnose

WBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWB

Jun 24, 2016 am 11:14 AM

Monaco Editor

The Monaco Editor is the code editor that powersVS Code, a good page describing the code editor's features is here .

Issues

Please mention the version of the editor when creating issues and the browser you're having trouble in.

This repository contains only the scripts to glue things together, please create issues against the actual repositories where the source code lives:

monaco-editor-core:Issues -- npm module (Issues with the editor itself)
monaco-typescript:Issues -- npm module (Issues with JavaScript or TypeScript language support)
monaco-languages:Issues -- npm module (Issues with bat, coffee script, cpp, csharp, fsharp, go, ini, jade, lua, objective-c, powershell, python, r, ruby, sql, swift, vb or xml)

Known issues

In IE, the editor must be completely surrounded in the body element, otherwise the hit testing we do for mouse operations does not work. You can inspect this using F12 and clicking on the body element and confirm that visually it surrounds the editor.

Installing

npm install monaco-editor

You will get:

inside dev : bundled, not minified
inside min : bundled, and minified
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.

Integrate

Here is the most basic HTML page that embeds the editor. More samples are available at monaco-editor-samples .

<!DOCTYPE html><html><head>    <meta http-equiv="X-UA-Compatible" content="IE=edge" />    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" ></head><body><div id="container" style="width:800px;height:600px;border:1px solid grey"></div><script src="monaco-editor/min/vs/loader.js"></script><script>    require.config({ paths: { 'vs': 'monaco-editor/min/vs' }});    require(['vs/editor/editor.main'], function() {        var editor = monaco.editor.create(document.getElementById('container'), {            value: [                'function x() {',                '\tconsole.log("Hello world!");',                '}'            ].join('\n'),            language: 'javascript'        });    });</script></body></html>

Integrate cross domain

If you are hosting your .js on a different domain (e.g. on a CDN) than the HTML, you should know that the Monaco Editor creates web workers for smart language features. Cross-domain web workers are not allowed, but here is how you can proxy their loading and get them to work:

<!--    Assuming the HTML lives on www.mydomain.com and that the editor is hosted on www.mycdn.com--><script type="text/javascript" src="http://www.mycdn.com/monaco-editor/min/vs/loader.js"></script><script>    require.config({ paths: { 'vs': 'http://www.mycdn.com/monaco-editor/min/vs' }});    // Before loading vs/editor/editor.main, define a global MonacoEnvironment that overwrites    // the default worker url location (used when creating WebWorkers). The problem here is that    // HTML5 does not allow cross-domain web workers, so we need to proxy the instantion of    // a web worker through a same-domain script    window.MonacoEnvironment = {        getWorkerUrl: function(workerId, label) {            return 'monaco-editor-worker-loader-proxy.js';        }    };    require(["vs/editor/editor.main"], function () {        // ...    });</script><!--    Create http://www.mydomain.com/monaco-editor-worker-loader-proxy.js with the following content:        self.MonacoEnvironment = {            baseUrl: 'http://www.mycdn.com/monaco-editor/min/'        };        importScripts('www.mycdn.com/monaco-editor/min/vs/base/worker/workerMain.js');    That's it. You're good to go! :)-->

Documentation

Please program against the API described in monaco.d.ts .

See the editor in action here .

Find full HTML sampleshere.

Explore API samples here .

Create a Monarch tokenizer here .

FAQ

Q: What is the relationship between VS Code and the Monaco Editor?

A: 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.

Q: What is the relationship between VS Code's version and the Monaco Editor's version?

A: None. The Monaco Editor is a library and it reflects directly the source code.

Q: I've written an extension for VS Code, will it work on the Monaco Editor in a browser?

A: No.

Q: Why all these web workers and why should I care?

A: Language services create web workers to compute heavy stuff outside 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).

Q: What is this loader.js ? Can I use require.js ?

A: It is an AMD loader that we use in VS Code. Yes.

Dev

Cheat Sheet

simpleserver with npm run simpleserver
release with npm run release
website with npm run website

Running monaco-editor-core from source

clone https://github.com/Microsoft/vscode in $/src/vscode/ (next to this repo)
run $/src/vscode> gulp watch
run $/src/monaco-editor> npm run simpleserver
edit $/src/monaco-editor/test/index.html and set var RUN_EDITOR_FROM_SOURCE = true;
open http://localhost:8080/monaco-editor/test/

Running a plugin (e.g. monaco-typescript) from source

clone https://github.com/Microsoft/monaco-typescript in $/src/monaco-typescript (next to this repo)
run $/src/monaco-typescript> npm run watch
run $/src/monaco-editor> npm run simpleserver
edit $/src/monaco-editor/test/index.html and set RUN_PLUGINS_FROM_SOURCE['monaco-typescript'] = true;
open http://localhost:8080/monaco-editor/test/

Shipping a new monaco-editor version

Ship a new monaco-editor-core version (if necessary)

bump version in https://github.com/Microsoft/vscode/blob/master/build/monaco/package.json
- if there is a breaking API change, bump the major (or the minor for 0.x.y)
push all local changes to the remote
generate npm package $/src/vscode> gulp editor-distro
publish npm package $/src/vscode/out-monaco-editor-core> npm publish

Adopt new monaco-editor-core in plugins (if necessary)

https://github.com/Microsoft/monaco-typescript
https://github.com/Microsoft/monaco-languages

Adopt new monaco-editor-core

edit $/src/monaco-editor/package.json and update the version for (as necessary):
- monaco-editor-core
- monaco-typescript
- monaco-languages
update the version in $/src/monaco-editor/package.json
- I try to keep it similar to monaco-editor-core , maybe just vary the patch version.
fetch latest deps by running $/src/monaco-editor> npm install .

Package monaco-editor

run $/src/monaco-editor> npm run release

Try out packaged bits

open http://localhost:8080/monaco-editor/test/index-release.html
open http://localhost:8080/monaco-editor/test/smoketest-release.html

Publish packaged bits

run $/src/monaco-editor/release> npm publish

Running the website from its source

run $/src/monaco-editor> npm run release
open http://localhost:8080/monaco-editor/website/

Generating the playground samples

edit $/src/monaco-editor/website/playground/playground.mdoc
run $/src/monaco-editor> gulp playground-samples

Publishing the website

run $/src/monaco-editor> npm run website
force-push the gh-pages branch: $/src/monaco-editor-website> git push origin gh-pages --force

License

MIT

Statement

The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Difficulty in updating caching of official account web pages: How to avoid the old cache affecting the user experience after version update?Mar 04, 2025 pm 12:32 PM

The official account web page update cache, this thing is simple and simple, and it is complicated enough to drink a pot of it. You worked hard to update the official account article, but the user still opened the old version. Who can bear the taste? In this article, let’s take a look at the twists and turns behind this and how to solve this problem gracefully. After reading it, you can easily deal with various caching problems, allowing your users to always experience the freshest content. Let’s talk about the basics first. To put it bluntly, in order to improve access speed, the browser or server stores some static resources (such as pictures, CSS, JS) or page content. Next time you access it, you can directly retrieve it from the cache without having to download it again, and it is naturally fast. But this thing is also a double-edged sword. The new version is online,

How to efficiently add stroke effects to PNG images on web pages?Mar 04, 2025 pm 02:39 PM

This article demonstrates efficient PNG border addition to webpages using CSS. It argues that CSS offers superior performance compared to JavaScript or libraries, detailing how to adjust border width, style, and color for subtle or prominent effect

What is the purpose of the <datalist> element?Mar 21, 2025 pm 12:33 PM

The article discusses the HTML <datalist> element, which enhances forms by providing autocomplete suggestions, improving user experience and reducing errors.Character count: 159

How do I use HTML5 form validation attributes to validate user input?Mar 17, 2025 pm 12:27 PM

The article discusses using HTML5 form validation attributes like required, pattern, min, max, and length limits to validate user input directly in the browser.

What are the best practices for cross-browser compatibility in HTML5?Mar 17, 2025 pm 12:20 PM

Article discusses best practices for ensuring HTML5 cross-browser compatibility, focusing on feature detection, progressive enhancement, and testing methods.

What is the purpose of the <progress> element?Mar 21, 2025 pm 12:34 PM

The article discusses the HTML <progress> element, its purpose, styling, and differences from the <meter> element. The main focus is on using <progress> for task completion and <meter> for stati

What is the purpose of the <meter> element?Mar 21, 2025 pm 12:35 PM

The article discusses the HTML <meter> element, used for displaying scalar or fractional values within a range, and its common applications in web development. It differentiates <meter> from <progress> and ex

How do I use the HTML5 <time> element to represent dates and times semantically?Mar 12, 2025 pm 04:05 PM

This article explains the HTML5 <time> element for semantic date/time representation. It emphasizes the importance of the datetime attribute for machine readability (ISO 8601 format) alongside human-readable text, boosting accessibilit

See all articles