search

FrontMatter / web-documentation-nextjs

Front Matter documenation
https://frontmatter.codes
25 stars 25 forks source link

(GH-11) Add, configure, and enforce markdownlint rules #12

Closed michaeltlombardi closed 2 years ago

michaeltlombardi commented 2 years ago

This change introduces markdownlint to the project, defining a basic configuration to enforce consistent syntax. It steps through the process, first adding the configuration, then settings/recommendations, then addressing the initial violations, and finally replaces inline links with reference links for readability.

For more information, see each commit in this changeset.

vercel[bot] commented 2 years ago

@michaeltlombardi is attempting to deploy a commit to the Front Matter Team on Vercel.

A member of the Team first needs to authorize it.

michaeltlombardi commented 2 years ago

It might be better to have it like this, although I never like it as you have to look elsewhere for the link. I like seeing where it gets inserted, but this might just be me, and I can get used to this change.

I absolutely feel you on this one, from my perspective it's been a maintainability/readability tradeoff (and helps with diffs). I actually just filed an issue with the VS Code Markdown language service to support a friendlier authoring/editing experience which would show the current link definitions on hover, instead of just enabling you to jump to the definition.