You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: styleguide.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
# Style guide
2
2
When contributing to the docs, follow the rules in this style guide.
3
3
4
-
## Vale Linter
5
-
To help you follow the style rules in this document, the Segment docs team uses Vale as a linter that will help you find style improvements. To run Vale:
4
+
## Vale linter
5
+
The Segment docs team uses Vale as a linter, or tool that helps you follow the style rules in our style guide. To run Vale:
6
6
7
-
1.Open the Segment docs folder from GH Desktop > Current Repository > segment-docs > Open in Terminal
8
-
2. In Visual Studio Code, copy the relative link to the .md file from tree in the sidebar.
9
-
3.type 'vale [relative-link]' into the terminal, press enter.
7
+
1.Navigate to the `segment-docs` folder, and open it in your terminal.
8
+
2. In your terminal, copy the relative link to the .md file you'd like to run through Vale.
9
+
3.Type 'vale [relative-link]' into your terminal and press enter.
10
10
11
-
You can also download and install the [Vale extension](https://marketplace.visualstudio.com/items?itemName=chrischinchilla.vale-vscode) to run Vale on demand.
11
+
VSCode users can also download and install the [Vale extension](https://marketplace.visualstudio.com/items?itemName=chrischinchilla.vale-vscode){:target="_blank”} to run Vale on demand.
0 commit comments