|
1 | 1 | # VSCode Web |
2 | | -This project is aimed to build a web version of VSCode, this is not a fork, simply a web compilation of the VSCode project. |
3 | | - |
4 | | -Here is a StackBlitz sample |
5 | | -https://stackblitz.com/edit/vscode-web |
6 | | - |
7 | | - |
8 | | -A similar compilation is used to generate [VSCode Web](https://vscode.dev) and [Github Dev](https://github.dev) |
9 | | -## Update |
10 | | -Microsoft recently open sourced VSCode web compilation, so I simplified the build process to use the official compilation (no more tweak needed). |
11 | | -Some modification have been made in the `index.html` file. |
12 | | - |
13 | | -## Use case |
14 | | -This project can be used to build a strong web file editor/reader. You need to implement your own [`FileSystemProvider`](https://code.visualstudio.com/api/references/vscode-api#FileSystemProvider) through extension. |
15 | | -Additional you can also use [proposed API](https://code.visualstudio.com/api/advanced-topics/using-proposed-api) to implement a `TextSearchProvider` and `FileSearchProvider`. |
16 | | - |
17 | | -## Sample project |
18 | | -This project is aimed to be used through npm package to avoid consumer to recompile whole solution. |
19 | | - |
20 | | -Sample project can be found in this repository to illustate vscode-web usage. This sample is not fully functional as it misses a `FileSystemProvider` extension. |
21 | | - |
22 | | -To run sample project |
23 | | -```sh |
24 | | -cd ./sample |
25 | | -yarn |
26 | | -yarn sample |
27 | | -``` |
28 | | - |
29 | | -## Extension Gallery |
30 | | -Based on VS MarketPlace rules, you are not allowed to consume VSCode Marketplace from your own VSCode Web |
31 | | -But [Open VSX Registry](https://open-vsx.org/) is here to provide an alternate marketplace. |
32 | 2 |
|
33 | | -See the [product.json](sample/product.json) file in `sample` folder to configure it. |
34 | | - |
35 | | - |
36 | | -## Build from source |
37 | | - |
38 | | -To build from source, you need same prerequisites as vscode : |
39 | | -[VSCode Prerequisites](https://github.com/microsoft/vscode/wiki/How-to-Contribute#prerequisites) |
40 | | - |
41 | | -Then simply run following commands |
42 | | - |
43 | | -``` |
44 | | -yarn |
45 | | -yarn build |
46 | | -``` |
47 | | - |
48 | | -## Run demo |
49 | | - |
50 | | -To run the demo you need to build from source, then run following commands |
51 | | - |
52 | | -``` |
53 | | -yarn prepare-demo |
54 | | -yarn demo |
55 | | -``` |
| 3 | +This project is aimed to build a web version of VSCode, this is not a fork, simply a web compilation of the VSCode project. |
0 commit comments