Skip to content

chore(docs): use vitepress #114

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

Merged
merged 1 commit into from
Oct 6, 2023
Merged

Conversation

ota-meshi
Copy link
Member

@ota-meshi ota-meshi commented Sep 23, 2023

This PR changes to use vitepress instead of vuepress to build the site.

#19 is not needed if we merge this PR.


preview https://ota-meshi.github.io/eslint-plugin-eslint-comments/

@ota-meshi ota-meshi changed the title chore: use vitepress chore(docs): use vitepress Sep 23, 2023
@codecov
Copy link

codecov bot commented Sep 23, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (3b53a57) 97.87% compared to head (250e6a7) 97.87%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #114   +/-   ##
=======================================
  Coverage   97.87%   97.87%           
=======================================
  Files          17       17           
  Lines         282      282           
=======================================
  Hits          276      276           
  Misses          6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ota-meshi ota-meshi requested review from a team October 2, 2023 00:28
Copy link
Member

@voxpelli voxpelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The resulting page looks nice 👍

I have no personal experience with Vitepress, only ever used Eleventy (and Jekyll), but if it works for you and you like it then I see nothing to object to here.

Disclaimer: I haven't looked through every single line of the code

Random remark: I see that this repo contains a mix of filename conventions – kebab case, pascal case and camel case. Apart from the lack of consistency I would advice against using pascal case or camel case for files as it can cause unexpected differences between case-sensitive and case-insensitive file systems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants