Skip to content

Commit 7ef754c

Browse files
author
Alpha Romer Coma
authored
Fix supported markdown-lint violations in markdown files (microsoft#190750)
docs: fix supported markdownlint violations
1 parent 42ff46c commit 7ef754c

File tree

27 files changed

+146
-130
lines changed

27 files changed

+146
-130
lines changed

.devcontainer/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ This dev container includes configuration for a development container for workin
1919
> **Note:** The Dev Containers extension requires the Visual Studio Code distribution of Code - OSS. See the [FAQ](https://aka.ms/vscode-remote/faq/license) for details.
2020
2121
4. Due to the size of the repository we strongly recommend cloning it on a Linux filesystem for better bind mount performance. On macOS we recommend using a Docker volume (press <kbd>F1</kbd> and select **Dev Containers: Clone Repository in Container Volume...**) and on Windows we recommend using a WSL folder:
22+
2223
- Make sure you are running a recent WSL version to get X11 and Wayland support.
2324
- Use the WSL extension for VS Code to open the cloned folder in WSL.
2425
- Press <kbd>F1</kbd> and select **Dev Containers: Reopen in Container**.
2526

2627
Next: **[Try it out!](#try-it)**
2728

28-
## Try it!
29+
## Try it
2930

3031
To start working with Code - OSS, follow these steps:
3132

@@ -50,6 +51,6 @@ Next, let's try debugging.
5051
5152
Enjoy!
5253
53-
# Notes
54+
## Notes
5455
5556
The container comes with VS Code Insiders installed. To run it from an Integrated Terminal use `VSCODE_IPC_HOOK_CLI= /usr/bin/code-insiders .`.

.devcontainer/prebuilt/README.md

+24-21
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ If you already have VS Code and Docker installed, you can click the badge above
1414

1515
2. **Important**: Docker needs at least **4 Cores and 8 GB of RAM** to run a full build with **9 GB of RAM** being recommended. If you are on macOS, or are using the old Hyper-V engine for Windows, update these values for Docker Desktop by right-clicking on the Docker status bar item and going to **Preferences/Settings > Resources > Advanced**.
1616

17-
> **Note:** The [Resource Monitor](https://marketplace.visualstudio.com/items?itemName=mutantdino.resourcemonitor) extension is included in the container so you can keep an eye on CPU/Memory in the status bar.
17+
> **Note:** The [Resource Monitor](https://marketplace.visualstudio.com/items?itemName=mutantdino.resourcemonitor) extension is included in the container so you can keep an eye on CPU/Memory in the status bar.
1818
1919
3. Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the [Dev Containers](https://aka.ms/vscode-remote/download/containers) extension.
2020

21-
![Image of Dev Containers extension](https://microsoft.github.io/vscode-remote-release/images/dev-containers-extn.png)
21+
![Image of Dev Containers extension](https://microsoft.github.io/vscode-remote-release/images/dev-containers-extn.png)
2222

23-
> **Note:** The Dev Containers extension requires the Visual Studio Code distribution of Code - OSS. See the [FAQ](https://aka.ms/vscode-remote/faq/license) for details.
23+
> **Note:** The Dev Containers extension requires the Visual Studio Code distribution of Code - OSS. See the [FAQ](https://aka.ms/vscode-remote/faq/license) for details.
2424
2525
4. Press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd> and select **Dev Containers: Clone Repository in Container Volume...**.
2626

27-
> **Tip:** While you can use your local source tree instead, operations like `yarn install` can be slow on macOS or when using the Hyper-V engine on Windows. We recommend the "clone repository in container" approach instead since it uses "named volume" rather than the local filesystem.
27+
> **Tip:** While you can use your local source tree instead, operations like `yarn install` can be slow on macOS or when using the Hyper-V engine on Windows. We recommend the "clone repository in container" approach instead since it uses "named volume" rather than the local filesystem.
2828
2929
5. Type `https://github.com/microsoft/vscode` (or a branch or PR URL) in the input box and press <kbd>Enter</kbd>.
3030

31-
6. After the container is running, open a web browser and go to [http://localhost:6080](http://localhost:6080), or use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to `localhost:5901` and enter `vscode` as the password.
31+
6. After the container is running, open a web browser and go to [http://localhost:6080](http://localhost:6080), or use a [VNC Viewer][def] to connect to `localhost:5901` and enter `vscode` as the password.
3232

3333
Anything you start in VS Code, or the integrated terminal, will appear here.
3434

@@ -54,41 +54,42 @@ Next: **[Try it out!](#try-it)**
5454

5555
### Using VS Code with GitHub Codespaces
5656

57-
You may see improved VNC responsiveness when accessing a codespace from VS Code client since you can use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/). Here's how to do it.
57+
You may see improved VNC responsiveness when accessing a codespace from VS Code client since you can use a [VNC Viewer][def]. Here's how to do it.
5858

59-
1. Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the the [GitHub Codespaces extension](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces).
59+
1. Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the the [GitHub Codespaces extension](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces).
6060

61-
> **Note:** The GitHub Codespaces extension requires the Visual Studio Code distribution of Code - OSS.
61+
> **Note:** The GitHub Codespaces extension requires the Visual Studio Code distribution of Code - OSS.
6262
6363
2. After the VS Code is up and running, press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd>, choose **Codespaces: Create New Codespace**, and use the following settings:
64-
- `microsoft/vscode` for the repository.
65-
- Select any branch (e.g. **main**) - you can select a different one later.
66-
- Choose **Standard** (4-core, 8GB) as the size.
6764

68-
4. After you have connected to the codespace, you can use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to `localhost:5901` and enter `vscode` as the password.
65+
- `microsoft/vscode` for the repository.
66+
- Select any branch (e.g. **main**) - you can select a different one later.
67+
- Choose **Standard** (4-core, 8GB) as the size.
68+
69+
3. After you have connected to the codespace, you can use a [VNC Viewer][def] to connect to `localhost:5901` and enter `vscode` as the password.
6970

7071
> **Tip:** You may also need change your VNC client's **Picture Quality** setting to **High** to get a full color desktop.
7172
72-
5. Anything you start in VS Code, or the integrated terminal, will appear here.
73+
4. Anything you start in VS Code, or the integrated terminal, will appear here.
7374

7475
Next: **[Try it out!](#try-it)**
7576

76-
## Try it!
77+
## Try it
7778

7879
This container uses the [Fluxbox](http://fluxbox.org/) window manager to keep things lean. **Right-click on the desktop** to see menu options. It works with GNOME and GTK applications, so other tools can be installed if needed.
7980

80-
> **Note:** You can also set the resolution from the command line by typing `set-resolution`.
81+
> **Note:** You can also set the resolution from the command line by typing `set-resolution`.
8182
8283
To start working with Code - OSS, follow these steps:
8384

8485
1. In your local VS Code client, open a terminal (<kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>\`</kbd>) and type the following commands:
8586

86-
```bash
87-
yarn install
88-
bash scripts/code.sh
89-
```
87+
```bash
88+
yarn install
89+
bash scripts/code.sh
90+
```
9091

91-
2. After the build is complete, open a web browser or a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to the desktop environment as described in the quick start and enter `vscode` as the password.
92+
2. After the build is complete, open a web browser or a [VNC Viewer][def] to connect to the desktop environment as described in the quick start and enter `vscode` as the password.
9293

9394
3. You should now see Code - OSS!
9495

@@ -98,8 +99,10 @@ Next, let's try debugging.
9899

99100
2. Go to your local VS Code client, and use the **Run / Debug** view to launch the **VS Code** configuration. (Typically the default, so you can likely just press <kbd>F5</kbd>).
100101

101-
> **Note:** If launching times out, you can increase the value of `timeout` in the "VS Code", "Attach Main Process", "Attach Extension Host", and "Attach to Shared Process" configurations in [launch.json](../../.vscode/launch.json). However, running `scripts/code.sh` first will set up Electron which will usually solve timeout issues.
102+
> **Note:** If launching times out, you can increase the value of `timeout` in the "VS Code", "Attach Main Process", "Attach Extension Host", and "Attach to Shared Process" configurations in [launch.json](../../.vscode/launch.json). However, running `scripts/code.sh` first will set up Electron which will usually solve timeout issues.
102103
103104
3. After a bit, Code - OSS will appear with the debugger attached!
104105

105106
Enjoy!
107+
108+
[def]: https://www.realvnc.com/en/connect/download/viewer/

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,6 @@ If you believe the bot got something wrong, please open a new issue and let us k
104104
If you are interested in writing code to fix issues,
105105
please see [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) in the wiki.
106106

107-
# Thank You!
107+
## Thank You
108108

109109
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Visual Studio Code - Open Source ("Code - OSS")
2+
23
[![Feature Requests](https://img.shields.io/github/issues/microsoft/vscode/feature-request.svg)](https://github.com/microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc)
34
[![Bugs](https://img.shields.io/github/issues/microsoft/vscode/bug.svg)](https://github.com/microsoft/vscode/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3Abug)
45
[![Gitter](https://img.shields.io/badge/chat-on%20gitter-yellow.svg)](https://gitter.im/Microsoft/vscode)
@@ -60,9 +61,10 @@ VS Code includes a set of built-in extensions located in the [extensions](extens
6061

6162
This repository includes a Visual Studio Code Dev Containers / GitHub Codespaces development container.
6263

63-
- For [Dev Containers](https://aka.ms/vscode-remote/download/containers), use the **Dev Containers: Clone Repository in Container Volume...** command which creates a Docker volume for better disk I/O on macOS and Windows.
64-
- If you already have VS Code and Docker installed, you can also click [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
65-
- For Codespaces, install the [GitHub Codespaces](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension in VS Code, and use the **Codespaces: Create New Codespace** command.
64+
* For [Dev Containers](https://aka.ms/vscode-remote/download/containers), use the **Dev Containers: Clone Repository in Container Volume...** command which creates a Docker volume for better disk I/O on macOS and Windows.
65+
* If you already have VS Code and Docker installed, you can also click [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
66+
67+
* For Codespaces, install the [GitHub Codespaces](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension in VS Code, and use the **Codespaces: Create New Codespace** command.
6668

6769
Docker / the Codespace should have at least **4 Cores and 6 GB of RAM (8 GB recommended)** to run full build. See the [development container README](.devcontainer/README.md) for more information.
6870

SECURITY.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ You should receive a response within 24 hours. If for some reason you do not, pl
1818

1919
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
2020

21-
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
22-
* Full paths of source file(s) related to the manifestation of the issue
23-
* The location of the affected source code (tag/branch/commit or direct URL)
24-
* Any special configuration required to reproduce the issue
25-
* Step-by-step instructions to reproduce the issue
26-
* Proof-of-concept or exploit code (if possible)
27-
* Impact of the issue, including how an attacker might exploit the issue
21+
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
22+
* Full paths of source file(s) related to the manifestation of the issue
23+
* The location of the affected source code (tag/branch/commit or direct URL)
24+
* Any special configuration required to reproduce the issue
25+
* Step-by-step instructions to reproduce the issue
26+
* Proof-of-concept or exploit code (if possible)
27+
* Impact of the issue, including how an attacker might exploit the issue
2828

2929
This information will help us triage your report more quickly.
3030

build/monaco/README-npm.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ The Monaco Editor is the code editor that powers [VS Code](https://github.com/mi
1010
This npm module contains the core editor functionality, as it comes from the [vscode repository](https://github.com/microsoft/vscode).
1111

1212
## License
13+
1314
[MIT](https://github.com/microsoft/vscode/blob/main/LICENSE.txt)

extensions/git-base/README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ The Git extension exposes an API, reachable by any other extension.
1414
2. Include `git-base.d.ts` in your extension's compilation.
1515
3. Get a hold of the API with the following snippet:
1616

17-
```ts
18-
const gitBaseExtension = vscode.extensions.getExtension<GitBaseExtension>('vscode.git-base').exports;
19-
const git = gitBaseExtension.getAPI(1);
20-
```
17+
```ts
18+
const gitBaseExtension = vscode.extensions.getExtension<GitBaseExtension>('vscode.git-base').exports;
19+
const git = gitBaseExtension.getAPI(1);
20+
21+
```

extensions/git/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The Git extension exposes an API, reachable by any other extension.
1414
2. Include `git.d.ts` in your extension's compilation.
1515
3. Get a hold of the API with the following snippet:
1616

17-
```ts
18-
const gitExtension = vscode.extensions.getExtension<GitExtension>('vscode.git').exports;
19-
const git = gitExtension.getAPI(1);
20-
```
17+
```ts
18+
const gitExtension = vscode.extensions.getExtension<GitExtension>('vscode.git').exports;
19+
const git = gitExtension.getAPI(1);
20+
```
+2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
The file `JavaScript.tmLanguage.json` is derived from [TypeScriptReact.tmLanguage](https://github.com/microsoft/TypeScript-TmLanguage/blob/master/TypeScriptReact.tmLanguage).
22

33
To update to the latest version:
4+
45
- `cd extensions/typescript` and run `npm run update-grammars`
56
- don't forget to run the integration tests at `./scripts/test-integration.sh`
67

78
The script does the following changes:
9+
810
- fileTypes .tsx -> .js & .jsx
911
- scopeName scope.tsx -> scope.js
1012
- update all rule names .tsx -> .js

extensions/json-language-features/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44

55
## Features
66

7-
See [JSON in Visual Studio Code](https://code.visualstudio.com/docs/languages/json) to learn about the features of this extension.
7+
See [JSON in Visual Studio Code](https://code.visualstudio.com/docs/languages/json) to learn about the features of this extension.

0 commit comments

Comments
 (0)