chore: setup markdownlint and fix markdown formatting

[okineadev]

Overview

• Fixed Markdownlint violations, simplified formatting, minimized HTML usage, and improved readability

  Copilot summary

  This pull request includes several changes to improve the formatting and consistency of markdown files across the repository. The most important changes include updating email and URL formatting, modifying the README.md layout, and updating image links.

  Formatting improvements:

  • CODE_OF_CONDUCT.md: Updated email and URL formatting to use angle brackets for consistency. [1] [2]
  • CONTRIBUTING.md: Updated URL formatting to use angle brackets for consistency.

  Layout and link updates:

  • README.md: Modified the layout to use markdownlint rules, updated image links, and improved readability by using markdown syntax for links and images. [1] [2]
  • SECURITY.md: Updated image link formatting to use markdown syntax for consistency.

[netlify]

❌ Deploy Preview for creative-fairy-df92c4 failed.

Name	Link
🔨 Latest commit	50cc855
🔍 Latest deploy log	https://app.netlify.com/sites/creative-fairy-df92c4/deploys/67b08e33f9558d0008a7f184

[aklinker1]

Thanks for wanting to fix lint errors, but we need to add the linter to the project, otherwise we're not going to follow the rules in any followup changes. So let's add markdownlint to the project and run it against all our files, and decide if it's something we want to follow or not.

At this point, I'm not convinced, seems like we're just adding a ton of ignore comments which is making things harder to read and maintain.

[okineadev]

Thanks for wanting to fix lint errors, but we need to add the linter to the project, otherwise we're not going to follow the rules in any followup changes. So let's add markdownlint to the project and run it against all our files, and decide if it's something we want to follow or not.

At this point, I'm not convinced, seems like we're just adding a ton of ignore comments which is making things harder to read and maintain.

Yes, you're right, I thought about it too, but we need to make it so that HTML is allowed in the docs/ folder, and in all other documents, let there be a warning to minimize the use of HTML

[okineadev]

I can do this tomorrow.

[aklinker1]

Awesome, thanks for adding it! Couple of cleanup items, and we'll get this merged

[aklinker1]

Looks like there are conflicts, once you fix them I'll get this merged!

[okineadev]

lockfile broken

[aklinker1]

lockfile broken

Can you just run:

git checkout main pnpm-lock.yaml
pnpm i

That should reset it to what's on the main branch, then reapply the new packages you added in this PR.

[okineadev]

lockfile broken

Can you just run:

git checkout main pnpm-lock.yaml
pnpm i

That should reset it to what's on the main branch, then reapply the new packages you added in this PR.

Probably fixed it

[aklinker1]

Hmm, I guess not. Now there's a problem with another dependency... I'll fix it and open another PR into your branch