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

style: apply markdown formatting #51

Merged
merged 1 commit into from
Jul 29, 2023

Conversation

bo5o
Copy link
Contributor

@bo5o bo5o commented Jul 29, 2023

  • add mdformat and markdownlint to pre-commit hooks
  • configure mdformat and markdownlint for github flavored markdown
  • auto-generate table of contents with proper document links/anchors
  • wrap long lines
  • avoid inline html where it is not necessary (e.g. ___ instead of <hr>)
  • use special highlighting directives for Note blocks

@bo5o bo5o force-pushed the chore/markdown-formatting branch 2 times, most recently from eab4d8e to 65499a4 Compare July 29, 2023 17:26
@bo5o bo5o force-pushed the chore/markdown-formatting branch from 65499a4 to b089a30 Compare July 29, 2023 17:28
@CKolkey
Copy link
Owner

CKolkey commented Jul 29, 2023

Ooooo fancy. I dig it, might have to steal some of this for neogit haha

@CKolkey CKolkey merged commit e084860 into CKolkey:master Jul 29, 2023
2 checks passed
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