Standardize use of whitespace in markdown files

apaskulin commented 6 years ago

This is an issue with:

[x] Bug (site functionality or styling)
[ ] Errata (fix needed for doc content)
[ ] New content (guide wanted)
[ ] Update (Add missing or refresh existing content)

Expected Behavior

Easy-to-review PRs and consistent whitespace formatting throughout the docs.

Note: Markdown tables in Hugo require a trailing space in the first line

Current Behavior

In some cases, editors are automatically changing line endings and other whitespace formatting in the markdown files, which makes for confusing PRs (see #381).

Possible Solution

Recommend an EditorConfig similar to sensu-go
Implement a linter like remarklint

asachs01 commented 6 years ago

:+1: FWIW, I use markdownlint

apaskulin commented 6 years ago

Noting that tables are ok with a closing pipe in the first line, possibly helping us with using markdownlint:

to           |     |
-------------|------
description  | Content

hillaryfraley commented 3 years ago

I think Vale might cover Markdown syntax and style rules: https://github.com/errata-ai/vale/

hillaryfraley commented 3 years ago

Hillary to follow Vale documentation to use locally to confirm whether we can customize with our style guide. I'm not sure Vale will lint for Markdown syntax and whitespace standardization.

hillaryfraley commented 3 years ago

I don't think Vale will work for our purposes. It seems to be a style linter.

sensu / sensu-docs