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
+10-1Lines changed: 10 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,14 @@
1
1
# Style guide
2
-
When contributing to the docs, please try to follow the rules in this style guide.
2
+
When contributing to the docs, follow the rules in this style guide.
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:
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.
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.
0 commit comments