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.

Sign up for GitHub

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

Jump to bottom

docs: introduce prettier and md-padding to format all docs #221

Merged
merged 4 commits into from
Dec 30, 2024
Merged

docs: introduce prettier and md-padding to format all docs #221

merged 4 commits into from
Dec 30, 2024

Conversation

spencercjh
Copy link
Contributor

I found that the project lacks some automated mechanism to format the document.

@dosubot dosubot bot added the size:XXL This PR changes 1000+ lines, ignoring generated files. label Dec 27, 2024
@vercel Vercel
Copy link

vercel bot commented Dec 27, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kyanos ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 30, 2024 6:18am

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Dec 27, 2024
@ccoVeille
Copy link

Please fix commit message and PR title. There is a typo, it's not pettier but prettier

@spencercjh spencercjh changed the title docs: introduce pettier and md-padding to format all docs docs: introduce prettier and md-padding to format all docs Dec 27, 2024
@spencercjh
Copy link
Contributor Author

Please fix commit message and PR title. There is a typo, it's not pettier but prettier

OMG 😮

DONE.

@hengyoush
Copy link
Owner

hengyoush commented Dec 27, 2024 •
edited
Loading

Very useful tool. Thank you! I left some comments, looks like it breaks the GitHub-flavored alerts

@spencercjh
Copy link
Contributor Author

Very useful tool. Thank you! I left some comments, looks like it breaks the GitHub-flavored alerts

This is an issue that has not been resolved by the prettier community. The solution is as follows: prettier/prettier#16454.

I don't know if you can accept it.

@hengyoush
Copy link
Owner

hengyoush commented Dec 30, 2024 •
edited
Loading

Very useful tool. Thank you! I left some comments, looks like it breaks the GitHub-flavored alerts

This is an issue that has not been resolved by the prettier community. The solution is as follows: prettier/prettier#16454.

I don't know if you can accept it.

you mean "add an empty line between note and text" or add "<!-- prettier-ignore -->"?

> [!IMPORTANT]
>
> **Lorem ipsum dolor sit amet, consectetur adipiscing elit**

I'm okay with these two.

hengyoush
hengyoush reviewed Dec 30, 2024
View reviewed changes
COMPILATION.md Outdated Show resolved Hide resolved
COMPILATION_CN.md Outdated Show resolved Hide resolved
docs/how-to-build.md Show resolved Hide resolved
@spencercjh spencercjh marked this pull request as draft December 30, 2024 05:27
@spencercjh spencercjh marked this pull request as ready for review December 30, 2024 06:15
@hengyoush
Copy link
Owner

LGTM

@hengyoush hengyoush merged commit 2b2b11f into hengyoush:main Dec 30, 2024
15 checks passed
@spencercjh spencercjh deleted the docs/md-lint branch December 30, 2024 07:32
XmchxUp pushed a commit to XmchxUp/kyanos that referenced this pull request Dec 31, 2024
@spencercjh @XmchxUp
docs: introduce prettier and md-padding to format all docs (hengy…
28798f3 
…oush#221)

* docs: introduce prettier and md-padding to format docs

Signed-off-by: spencercjh <[email protected]>

* fix: make github alerts work

Signed-off-by: spencercjh <[email protected]>

* fix: make all markdown extensions work

Signed-off-by: spencercjh <[email protected]>

* fix: reformat new codes from main

Signed-off-by: spencercjh <[email protected]>

---------

Signed-off-by: spencercjh <[email protected]>
hengyoush pushed a commit that referenced this pull request Jan 6, 2025
@spencercjh @hengyoush
docs: introduce prettier and md-padding to format all docs (#221)
7c323d6 
* docs: introduce prettier and md-padding to format docs

Signed-off-by: spencercjh <[email protected]>

* fix: make github alerts work

Signed-off-by: spencercjh <[email protected]>

* fix: make all markdown extensions work

Signed-off-by: spencercjh <[email protected]>

* fix: reformat new codes from main

Signed-off-by: spencercjh <[email protected]>

---------

Signed-off-by: spencercjh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hengyoush hengyoush hengyoush left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@spencercjh @ccoVeille @hengyoush