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
+
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
+
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
+
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