Skip to content

Fix README markdown #187

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

Merged
merged 1 commit into from
Oct 4, 2016
Merged

Conversation

Yukaii
Copy link
Member

@Yukaii Yukaii commented Oct 4, 2016

Changes

  • add extra line after heading(MD022)
  • trim trailing whitespace
  • change tab(hard tab) in Structure section to white spaces, make it aligned beautiful again 😆
  • add link for operational tranformation

@jackycute
Copy link
Member

Thank you @Yukaii !
First seeing that markdownlint stuff, really helpful.

@jackycute jackycute merged commit 2c49c53 into hackmdio:master Oct 4, 2016
@jackycute
Copy link
Member

I've also noticed other rules in the lint.
Will try to fit them into current editor behaviors.

@jackycute
Copy link
Member

As you see, when you trim the trailing spaces for new line, it will break the layout on the GitHub.
HackMD use breaks while GitHub use 2 trailing spaces for break.
But the README.md here is more for GitHub, may consider add them back.
What do you think?

@Yukaii
Copy link
Member Author

Yukaii commented Oct 4, 2016

screen shot 2016-10-04 at 5 30 52 pm

I haven't noticed yet, sorry about that.

In markdown, we might need an extra line to do correct line break 😓 , but there will be the larger line height on GitHub.

@jackycute
Copy link
Member

So how about we add back the trailing spaces, it's necessary for GitHub.
The lint rules also mentioned that if you use two spaces for new line, it's allow to change that rule.

@Yukaii
Copy link
Member Author

Yukaii commented Oct 4, 2016

OK!

JJediny pushed a commit to 18F/codimd-cloudgov-template that referenced this pull request Dec 16, 2020
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.

2 participants