Skip to content

(MAINT) Clarify line length for about topics #11307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 1, 2024
Merged

(MAINT) Clarify line length for about topics #11307

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1bea26
(MAINT) Clarify line length for about topics
michaeltlombardi Aug 1, 2024
63fa3fe
Update reference/docs-conceptual/community/contributing/general-markd…
sdwheeler Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions reference/docs-conceptual/community/contributing/general-markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: This article provides specific guidance for using Markdown in our documentation.
ms.date: 04/23/2024
ms.date: 08/01/2024
title: Markdown best practices
---
# Markdown best practices
Expand Down Expand Up @@ -50,9 +50,9 @@ Only use [ATX headings][07] (`#` style, as opposed to `=` or `-` style headers).

## Limit line length to 100 characters

This applies to conceptual articles and cmdlet reference. Limiting the line length improves the
readability of `git` diffs and history. It also makes it easier for other writers to make
contributions.
This applies to conceptual articles and cmdlet reference. For `about_` topics, limit the line
length to 79 characters. Limiting the line length improves the readability of `git` diffs and
history. It also makes it easier for other writers to make contributions.

Use the [Reflow Markdown][09] extension in VS Code to reflow paragraphs to fit the prescribed line
length.
Expand Down