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

docs: 📝Update README to improve Markdown linting and structure #18498

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

okineadev
Copy link

Description

Improved and simplified centering of elements, added exclusion of some rules for markdownlint, allowed to use HTML only where it is really necessary (tags for centering elements) and nowhere else, this will prevent the use of HTML instead of native Markdown, which will positively affect the readability of the code

@okineadev okineadev changed the title Update README to improve Markdown linting and structure docs: 📝Update README to improve Markdown linting and structure Oct 28, 2024
@patak-dev
Copy link
Member

Thanks! It seems we are missing some padding after the logo after the PR
image

@okineadev
Copy link
Author

Thanks! It seems we are missing some padding after the logo after the PR image

Fixed in e1e3005 👍

@patak-dev
Copy link
Member

The current one with more padding feels more balanced 🤔

@okineadev
Copy link
Author

The current one with more padding feels more balanced 🤔

Fixed in 475ea5d

@okineadev
Copy link
Author

Done.

@patak-dev
Copy link
Member

I'll let others take a look before, to be honest the added markdownlint comments are quite noisy.

@okineadev
Copy link
Author

I'll let others take a look before, to be honest the added markdownlint comments are quite noisy.

They do not interfere with anything and do not bite

@okineadev
Copy link
Author

okineadev commented Oct 29, 2024

A little off topic
I think it would be good to move the name to the logo so that it is easier to recognize the name of the tool:


Vite logo

      Vite ⚡

npm package node.js compatibility build status Start new PR in StackBlitz Codeflow discord chat

@sapphi-red
Copy link
Member

sapphi-red commented Oct 30, 2024

If we want to introduce markdownlint, I think we should add it to the CI, otherwise people that installed it might get a lint error that was edited by people that didn't install it.
But I don't think it's needed for us (at least for me), because I don't have strong preference with code styles of markdown files and I check the code correctness by the preview. I assume it does not support vitepress's syntaxes and the files that can be linted will be quite limited in that case. Also some stylistic rules may conflict with prettier and resolving that might take time more than it's worth.

@okineadev
Copy link
Author

If we want to introduce markdownlint, I think we should add it to the CI, otherwise people that installed it might get a lint error that was edited by people that didn't install it.
But I don't think it's needed for us (at least for me), because I don't have strong preference with code styles of markdown files and I check the code correctness by the preview. I assume it does not support vitepress's syntaxes and the files that can be linted will be quite limited in that case. Also some stylistic rules may conflict with prettier and resolving that might take time more than it's worth.

Look, I'm not planning to add CI for linting now, I want it to be at least this way now, I'll look at the vitepres support later

Let this PR stay.

@bluwy
Copy link
Member

bluwy commented Oct 30, 2024

Tbh I don't really see the point of changing the markup and looking the same anyways. Sorry to be a bit harsh here, but I'd appreciate if the PRs were addressing actual bugs or issues, rather than subjective / own-opinion / styling changes, especially for first time contributions.

@okineadev
Copy link
Author

Tbh I don't really see the point of changing the markup and looking the same anyways. Sorry to be a bit harsh here, but I'd appreciate if the PRs were addressing actual bugs or issues, rather than subjective / own-opinion / styling changes, especially for first time contributions.

Well, you suffocated..

@okineadev
Copy link
Author

review

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.

4 participants