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[bot]]

✅ Deploy Preview for creative-fairy-df92c4 ready!

Name	Link
🔨 Latest commit	7e9c0a799d146a7059943c31a394d8b06e4f9459
🔍 Latest deploy log	https://app.netlify.com/sites/creative-fairy-df92c4/deploys/67f7705aead9110008157885
😎 Deploy Preview	https://deploy-preview-1386--creative-fairy-df92c4.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[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.

[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

[aklinker1]

@okineadev Can you merge this with main? Than we'll get this merged!

[okineadev]

@okineadev Can you merge this with main? Than we'll get this merged!

I did it, is it okay now?

[aklinker1]

Yup, running checks now. If they pass we can merge.

[pkg-pr-new[bot]]

Open in StackBlitz

@wxt-dev/analytics

npm i https://pkg.pr.new/@wxt-dev/analytics@1386

@wxt-dev/auto-icons

npm i https://pkg.pr.new/@wxt-dev/auto-icons@1386

@wxt-dev/browser

npm i https://pkg.pr.new/@wxt-dev/browser@1386

@wxt-dev/i18n

npm i https://pkg.pr.new/@wxt-dev/i18n@1386

@wxt-dev/module-react

npm i https://pkg.pr.new/@wxt-dev/module-react@1386

@wxt-dev/module-solid

npm i https://pkg.pr.new/@wxt-dev/module-solid@1386

@wxt-dev/module-svelte

npm i https://pkg.pr.new/@wxt-dev/module-svelte@1386

@wxt-dev/module-vue

npm i https://pkg.pr.new/@wxt-dev/module-vue@1386

@wxt-dev/storage

npm i https://pkg.pr.new/@wxt-dev/storage@1386

@wxt-dev/unocss

npm i https://pkg.pr.new/@wxt-dev/unocss@1386

@wxt-dev/webextension-polyfill

npm i https://pkg.pr.new/@wxt-dev/webextension-polyfill@1386

wxt

npm i https://pkg.pr.new/wxt@1386

commit: f778933

[okineadev]

Actually, can you also add a step to the validate workflow to ensure markdownlint is ran? Otherwise it's just going to be ignored.

Ok, I'll set it all up now.

[okineadev]

https://github.com/wxt-dev/wxt/blob/7e9c0a799d146a7059943c31a394d8b06e4f9459/.github/workflows/validate.yml#L59-L91

Could we use a matrix: here?

We would need to optimize the workflow, but that is beyond the scope of this PR

[aklinker1]

Could we use a matrix: here?

Yes, PR: https://github.com/wxt-dev/wxt/pull/1708

[aklinker1]

Closing this in favor of #1709. After coming back to this, there are too many changes I want to make to this PR so I brought the minimal changes over to a new PR.