mirror of
https://github.com/microsoft/monaco-editor.git
synced 2024-11-25 16:35:44 +08:00
Update links
This commit is contained in:
parent
97da96fa8c
commit
903a92c7bb
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
@ -44,7 +44,7 @@ jobs:
|
|||||||
- name: Run unit tests
|
- name: Run unit tests
|
||||||
run: npm test
|
run: npm test
|
||||||
|
|
||||||
- name: Build webpack plugin
|
- name: Compile webpack plugin
|
||||||
run: npm run compile --prefix webpack-plugin
|
run: npm run compile --prefix webpack-plugin
|
||||||
|
|
||||||
- name: Package using webpack plugin
|
- name: Package using webpack plugin
|
||||||
|
@ -54,20 +54,32 @@ You need to have all the build setup of VS Code to be able to build the Monaco E
|
|||||||
# install npm deps for monaco-editor
|
# install npm deps for monaco-editor
|
||||||
/src/monaco-editor> npm install .
|
/src/monaco-editor> npm install .
|
||||||
|
|
||||||
# compile all plugins
|
# compile and bundle all plugins
|
||||||
/src/monaco-editor> npm run release
|
/src/monaco-editor> npm run release
|
||||||
|
|
||||||
# start a local http server in the background
|
# start a local http server in the background
|
||||||
/src/monaco-editor> npm run simpleserver
|
/src/monaco-editor> npm run simpleserver
|
||||||
```
|
```
|
||||||
|
|
||||||
Open [http://localhost:8080/monaco-editor/test/?editor=src](http://localhost:8080/monaco-editor/test/?editor=src) to run.
|
Open [http://localhost:8080/monaco-editor/test/manual/?editor=src](http://localhost:8080/monaco-editor/test/manual/?editor=src) to run.
|
||||||
|
|
||||||
## Running the editor tests
|
## Running the editor tests
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
/src/vscode> npm run monaco-editor-test
|
# create a local release
|
||||||
# or run a test page http://localhost:8080/monaco-editor/test/?editor=src
|
/src/monaco-editor> npm run release
|
||||||
|
|
||||||
|
# run unit tests
|
||||||
|
/src/monaco-editor> npm run test
|
||||||
|
|
||||||
|
# compile the webpack plugin
|
||||||
|
/src/monaco-editor> npm run compile --prefix webpack-plugin
|
||||||
|
|
||||||
|
# package using the webpack plugin
|
||||||
|
/src/monaco-editor> npm run smoketest --prefix webpack-plugin
|
||||||
|
|
||||||
|
# run the smoketest
|
||||||
|
/src/monaco-editor> npm run smoketest-debug
|
||||||
```
|
```
|
||||||
|
|
||||||
> Tip: All folders must be cloned as siblings.
|
> Tip: All folders must be cloned as siblings.
|
||||||
@ -106,7 +118,7 @@ Open [http://localhost:8080/monaco-editor/test/?editor=src](http://localhost:808
|
|||||||
- generate npm package `/src/vscode> yarn gulp editor-distro`
|
- generate npm package `/src/vscode> yarn gulp editor-distro`
|
||||||
- publish npm package `/src/vscode/out-monaco-editor-core> npm publish`
|
- publish npm package `/src/vscode/out-monaco-editor-core> npm publish`
|
||||||
|
|
||||||
#### 2. Update `monaco-editor-core`
|
#### 2. Adopt new `monaco-editor-core` version
|
||||||
|
|
||||||
- edit `/src/monaco-editor/package.json` and update the version of [`monaco-editor-core`](https://www.npmjs.com/package/monaco-editor-core)
|
- edit `/src/monaco-editor/package.json` and update the version of [`monaco-editor-core`](https://www.npmjs.com/package/monaco-editor-core)
|
||||||
|
|
||||||
@ -117,16 +129,11 @@ Open [http://localhost:8080/monaco-editor/test/?editor=src](http://localhost:808
|
|||||||
|
|
||||||
#### 4. Generate and try out the local release
|
#### 4. Generate and try out the local release
|
||||||
|
|
||||||
- `/src/monaco-editor> npm run release`
|
- run the editor smoketest via CI or [manually](#running-the-editor-tests).
|
||||||
- try as many test pages as you think are relevant. e.g.:
|
|
||||||
- open `http://localhost:8080/monaco-editor/test/?editor=releaseDev`
|
|
||||||
- open `http://localhost:8080/monaco-editor/test/?editor=releaseMin`
|
|
||||||
- open `http://localhost:8080/monaco-editor/test/smoketest.html?editor=releaseDev`
|
|
||||||
- open `http://localhost:8080/monaco-editor/test/smoketest.html?editor=releaseMin`
|
|
||||||
|
|
||||||
#### 5. Update release note.
|
#### 5. Update release note.
|
||||||
|
|
||||||
- API Change/Breaking Change/New and noteworthy
|
- API Changes / Breaking Changes / New and noteworthy
|
||||||
- Thank you ([use this tool](https://vscode-tools.azurewebsites.net/))
|
- Thank you ([use this tool](https://vscode-tools.azurewebsites.net/))
|
||||||
|
|
||||||
#### 6. Publish
|
#### 6. Publish
|
||||||
@ -134,7 +141,7 @@ Open [http://localhost:8080/monaco-editor/test/?editor=src](http://localhost:808
|
|||||||
- `/src/monaco-editor> npm version minor`
|
- `/src/monaco-editor> npm version minor`
|
||||||
- `/src/monaco-editor> npm run release`
|
- `/src/monaco-editor> npm run release`
|
||||||
- `/src/monaco-editor/release> npm publish`
|
- `/src/monaco-editor/release> npm publish`
|
||||||
- `/src/monaco-editor> git push --tags`
|
- `/src/monaco-editor> git push origin v0.50.0`
|
||||||
|
|
||||||
#### 7. Update Website
|
#### 7. Update Website
|
||||||
|
|
||||||
@ -142,8 +149,8 @@ Open [http://localhost:8080/monaco-editor/test/?editor=src](http://localhost:808
|
|||||||
|
|
||||||
#### 8. Publish new webpack plugin
|
#### 8. Publish new webpack plugin
|
||||||
|
|
||||||
- https://github.com/microsoft/monaco-editor-webpack-plugin
|
- **TBD**
|
||||||
- update to latest `monaco-editor`
|
- https://github.com/microsoft/monaco-editor/tree/main/webpack-plugin
|
||||||
- `npm install .`
|
- `npm install .`
|
||||||
- `npm run import-editor`
|
- `npm run import-editor`
|
||||||
- if there are no changes generated after the script:
|
- if there are no changes generated after the script:
|
||||||
|
@ -34,8 +34,8 @@ It is recommended to develop against the `dev` version, and in production to use
|
|||||||
- [Integrate the AMD version](./docs/integrate-amd.md).
|
- [Integrate the AMD version](./docs/integrate-amd.md).
|
||||||
- [Integrate the ESM version](./docs/integrate-esm.md)
|
- [Integrate the ESM version](./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).
|
- 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/gh-pages/playground/monaco.d.ts.txt).
|
- 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/main/website/typedoc/monaco.d.ts).
|
||||||
- Read [this guide](https://github.com/Microsoft/monaco-editor/wiki/Accessibility-Guide-for-Integrators) to ensure the editor is accessible to all your users!
|
- 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).
|
- 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!
|
- Ask questions on [StackOverflow](https://stackoverflow.com/questions/tagged/monaco-editor)! Search open and closed issues, there are a lot of tips in there!
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Here is the most basic HTML page that embeds the editor using AMD.
|
Here is the most basic HTML page that embeds the editor using AMD.
|
||||||
|
|
||||||
More self-contained samples are available at [monaco-editor-samples](https://github.com/Microsoft/monaco-editor-samples).
|
More self-contained samples are available in the [samples folder](../samples/).
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
|
@ -10,13 +10,13 @@
|
|||||||
|
|
||||||
Here is the most basic script that imports the editor using ESM with webpack.
|
Here is the most basic script that imports the editor using ESM with webpack.
|
||||||
|
|
||||||
More self-contained samples are available at [monaco-editor-samples](https://github.com/Microsoft/monaco-editor-samples).
|
More self-contained samples are available in the [samples folder](../samples/).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Option 1: Using the Monaco Editor WebPack Plugin
|
### Option 1: Using the Monaco Editor WebPack Plugin
|
||||||
|
|
||||||
This is the easiest method, and it allows for options to be passed into the plugin in order to select only a subset of editor features or editor languages. Read more about the [Monaco Editor WebPack Plugin](https://github.com/Microsoft/monaco-editor-webpack-plugin), which is a community authored plugin.
|
This is the easiest method, and it allows for options to be passed into the plugin in order to select only a subset of editor features or editor languages. Read more about the [Monaco Editor WebPack Plugin](../webpack-plugin/), which is a community authored plugin.
|
||||||
|
|
||||||
- `index.js`
|
- `index.js`
|
||||||
|
|
||||||
@ -61,7 +61,7 @@ module.exports = {
|
|||||||
|
|
||||||
### Option 2: Using plain webpack
|
### Option 2: Using plain webpack
|
||||||
|
|
||||||
Full working samples are available at https://github.com/Microsoft/monaco-editor-samples/tree/master/browser-esm-webpack or https://github.com/Microsoft/monaco-editor-samples/tree/master/browser-esm-webpack-small
|
Full working samples are available at https://github.com/microsoft/monaco-editor/tree/main/samples/browser-esm-webpack or https://github.com/microsoft/monaco-editor/tree/main/samples/browser-esm-webpack-small
|
||||||
|
|
||||||
- `index.js`
|
- `index.js`
|
||||||
|
|
||||||
@ -134,7 +134,7 @@ module.exports = {
|
|||||||
|
|
||||||
### Using parcel
|
### Using parcel
|
||||||
|
|
||||||
A full working sample is available at https://github.com/Microsoft/monaco-editor-samples/tree/master/browser-esm-parcel
|
A full working sample is available at https://github.com/microsoft/monaco-editor/tree/main/samples/browser-esm-parcel
|
||||||
|
|
||||||
When using parcel, we need to use the `getWorkerUrl` function and build the workers seperately from our main source. To simplify things, we can write a tiny bash script to build the workers for us.
|
When using parcel, we need to use the `getWorkerUrl` function and build the workers seperately from our main source. To simplify things, we can write a tiny bash script to build the workers for us.
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Monaco Editor Webpack Loader Plugin
|
# Monaco Editor Webpack Loader Plugin
|
||||||
|
|
||||||
A plugin to simplify loading the [Monaco Editor](https://github.com/Microsoft/monaco-editor) with [webpack](https://webpack.js.org/).
|
A plugin to simplify loading the [Monaco Editor](https://github.com/microsoft/monaco-editor) with [webpack](https://webpack.js.org/).
|
||||||
|
|
||||||
## Installing
|
## Installing
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@
|
|||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/microsoft/monaco-editor-webpack-plugin.git"
|
"url": "git+https://github.com/microsoft/monaco-editor.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"webpack",
|
"webpack",
|
||||||
@ -25,9 +25,9 @@
|
|||||||
"author": "Microsoft Corporation",
|
"author": "Microsoft Corporation",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/microsoft/monaco-editor-webpack-plugin/issues"
|
"url": "https://github.com/microsoft/monaco-editor/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/microsoft/monaco-editor-webpack-plugin#readme",
|
"homepage": "https://github.com/microsoft/monaco-editor#readme",
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"webpack": "^4.5.0 || 5.x",
|
"webpack": "^4.5.0 || 5.x",
|
||||||
"monaco-editor": "0.30.x"
|
"monaco-editor": "0.30.x"
|
||||||
|
Loading…
Reference in New Issue
Block a user