Skip to content

Commit f7f1520

Browse files
Fix some markdownlint errors in README (PowerShell#1416)
1 parent 23f4aa2 commit f7f1520

File tree

2 files changed

+31
-27
lines changed

2 files changed

+31
-27
lines changed

.markdownlint.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"MD013": false,
3+
"MD033": false
4+
}

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ experience in almost any editor or integrated development environment (IDE).
1414

1515
The functionality in PowerShell Editor Services is already available in the following editor extensions:
1616

17-
- [The VSCode PowerShell extension](https://github.com/PowerShell/vscode-powershell), also available in Azure Data Studio
18-
- [coc-powershell](https://github.com/yatli/coc-powershell), a vim/neovim PowerShell plugin
19-
- [The IntelliJ PowerShell plugin](https://github.com/ant-druha/intellij-powershell)
20-
- [lsp-powershell](https://github.com/kiennq/lsp-powershell), an Emacs PowerShell plugin
17+
- [The VSCode PowerShell extension](https://github.com/PowerShell/vscode-powershell), also available in Azure Data Studio
18+
- [coc-powershell](https://github.com/yatli/coc-powershell), a vim/neovim PowerShell plugin
19+
- [The IntelliJ PowerShell plugin](https://github.com/ant-druha/intellij-powershell)
20+
- [lsp-powershell](https://github.com/kiennq/lsp-powershell), an Emacs PowerShell plugin
2121

2222
## Features
2323

24-
- The Language Service provides common editor features for the PowerShell language:
25-
- Code navigation actions (find references, go to definition)
26-
- Statement completions (IntelliSense)
27-
- Real-time semantic analysis of scripts using PowerShell Script Analyzer
28-
- The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc)
29-
- The [$psEditor API](http://powershell.github.io/PowerShellEditorServices/guide/extensions.html) enables scripting of the host editor
30-
- A full, terminal-based Integrated Console experience for interactive development and debugging
24+
- The Language Service provides common editor features for the PowerShell language:
25+
- Code navigation actions (find references, go to definition)
26+
- Statement completions (IntelliSense)
27+
- Real-time semantic analysis of scripts using PowerShell Script Analyzer
28+
- The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc)
29+
- The [$psEditor API](http://powershell.github.io/PowerShellEditorServices/guide/extensions.html) enables scripting of the host editor
30+
- A full, terminal-based Integrated Console experience for interactive development and debugging
3131

3232
## Usage
3333

@@ -39,8 +39,8 @@ If you're looking for the more feature-rich experience,
3939
Named Pipes are the way to go.
4040
They give you all the benefit of the Language Server Protocol with extra capabilities that you can take advantage of:
4141

42-
- The PowerShell Integrated Console
43-
- Debugging using the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/)
42+
- The PowerShell Integrated Console
43+
- Debugging using the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/)
4444

4545
The typical command to start PowerShell Editor Services using named pipes is as follows:
4646

@@ -50,8 +50,8 @@ pwsh -NoLogo -NoProfile -Command "$PSES_BUNDLE_PATH/PowerShellEditorServices/Sta
5050

5151
> NOTE: In the example above,
5252
>
53-
> - `$PSES_BUNDLE_PATH` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
54-
> - `$SESSION_TEMP_PATH` is the folder path that you'll use for this specific editor session.
53+
> - `$PSES_BUNDLE_PATH` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
54+
> - `$SESSION_TEMP_PATH` is the folder path that you'll use for this specific editor session.
5555
5656
Once the command is run,
5757
PowerShell Editor Services will wait until the client connects to the Named Pipe.
@@ -102,8 +102,8 @@ pwsh -NoLogo -NoProfile -Command "$PSES_BUNDLE_PATH/PowerShellEditorServices/Sta
102102

103103
> NOTE: In the example above,
104104
>
105-
> - `$PSES_BUNDLE_PATH` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
106-
> - `$SESSION_TEMP_PATH` is the folder path that you'll use for this specific editor session.
105+
> - `$PSES_BUNDLE_PATH` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
106+
> - `$SESSION_TEMP_PATH` is the folder path that you'll use for this specific editor session.
107107
108108
The important flag is the `-Stdio` flag which enables this communication protocol.
109109

@@ -113,9 +113,9 @@ Currently, the Emacs extension uses Stdio.
113113

114114
Please note that we only consider the following as stable APIs that can be relied on:
115115

116-
- Language server protocol connection
117-
- Debug adapter protocol connection
118-
- Start up mechanism
116+
- Language server protocol connection
117+
- Debug adapter protocol connection
118+
- Start up mechanism
119119

120120
The types of PowerShell Editor Services can change at any moment and should not be linked against in production environment.
121121

@@ -127,13 +127,13 @@ The types of PowerShell Editor Services can change at any moment and should not
127127

128128
Install PowerShell 7+ with [these instructions](https://github.com/PowerShell/PowerShell#get-powershell).
129129

130-
### 3. Clone the GitHub repository:
130+
### 2. Clone the GitHub repository
131131

132-
```
132+
```powershell
133133
git clone https://github.com/PowerShell/PowerShellEditorServices.git
134134
```
135135

136-
### 4. Install [Invoke-Build](https://github.com/nightroman/Invoke-Build)
136+
### 3. Install [Invoke-Build](https://github.com/nightroman/Invoke-Build)
137137

138138
```powershell
139139
Install-Module InvokeBuild -Scope CurrentUser
@@ -152,16 +152,16 @@ PS C:\path\to\PowerShellEditorServices> Invoke-Build Build
152152
Open the PowerShellEditorServices folder that you cloned locally and press <kbd>Ctrl+Shift+B</kbd>
153153
(or <kbd>Cmd+Shift+B</kbd> on macOS).
154154

155-
## Contributions Welcome!
155+
## Contributions Welcome
156156

157157
We would love to incorporate community contributions into this project. If you would like to
158158
contribute code, documentation, tests, or bug reports, please read our [Contribution Guide](http://powershell.github.io/PowerShellEditorServices/CONTRIBUTING.html) to learn more.
159159

160160
## Maintainers
161161

162-
- [Patrick Meinecke](https://github.com/SeeminglyScience) - [@SeeminglyScienc](http://twitter.com/SeeminglyScienc)
163-
- [Rob Holt](https://github.com/rjmholt) - [@rjmholt](https://twitter.com/rjmholt)
164-
- [Andy Schwartzmeyer](https://github.com/andschwa) - [andschwa.com](https://andschwa.com/)
162+
- [Patrick Meinecke](https://github.com/SeeminglyScience) - [@SeeminglyScienc](http://twitter.com/SeeminglyScienc)
163+
- [Rob Holt](https://github.com/rjmholt) - [@rjmholt](https://twitter.com/rjmholt)
164+
- [Andy Schwartzmeyer](https://github.com/andschwa) - [andschwa.com](https://andschwa.com/)
165165

166166
## License
167167

0 commit comments

Comments
 (0)