Skip to content
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.

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

docs: add editorconfig for markdown #1136

Open
wants to merge 2 commits into
base: public
Choose a base branch
from

Conversation

reconbot
Copy link
Contributor

@reconbot reconbot commented Jun 3, 2023

I was trying to fix a link in in a document and couldn't get github, my editor or my local git to preserve the mixed line endings in the file. Instead of doing that I figured I could help fix it.

Editorconfig is natively supported by most popular editors and keeps formatting issues like this away.

  • First commit sets up editorconfig for markdown files using the most commonly used line endings.
  • Second commit formats all the markdown files.

I was trying to fix a link in in a document and couldn't get github, my editor or my local git to perserve the mixed line endings in the file. Instead of doing that I figued I could help fix it.

[Editorconfig](https://editorconfig.org/#) is nativly supported by most popular editors and keeps formatting issues like this away. I've set it up for markdown files using the most commonly used line endings.
from the settings in editorconfig
@phoddie
Copy link
Collaborator

phoddie commented Jun 3, 2023

Thank you for the fix. We'll get that merged. It can only make life better.

(How embarrassing that we have inconsistent line endings)

mkellner added a commit that referenced this pull request Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants