Description
The usage of they <kbd>
tag would be better than bold or just normal text. Currently, <kbd>
is used in a really few articles. Example where it's used is Tutorial: Create a .NET Core solution in macOS using Visual Studio Code.
General markdown improvements:
Make sure that the following points from the current style guide are followed:
- This point caused an issue before with some regex being rendered incorrectly. There could be many occurrences where it causes a problem.
Markdown uses special characters such as *, `, and # for formatting. If you wish to include one of these characters in your content, you must do one of two things:
- Put a backslash before the special character to "escape" it (for example, * for a *)
- Use the HTML entity code for the character (for example, * for a *).
- This is less priority but may be taken into consideration at some point of time.
File names use the following rules:
- Use action verbs that are specific, such as develop, buy, build, troubleshoot. No -ing words.
- No small words - don't include a, and, the, in, or, etc.
- This was changed in the guide soon, it was to capitalize the word following a colon, so there are a lot of articles that doesn't follow this current guide.
Use sentence-style capitalization. Always capitalize the first word of a heading, but don't capitalize the word following a colon in a title or heading (for example, "How to: sort an array").
Italics Use for files, folders, paths (for long items, split onto their own line), new terms.
Bold Use for UI elements.
Code
Use for inline code, language keywords, NuGet package names, command-line commands, database table and column names, and URLs that you don't want to be clickable.
/cc @mairaw, @rpetrusha, @BillWagner, @Thraka, Thoughts ?