add docs page to cancancan using vitepress #841
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pandermatt
commented
Mar 15, 2024
docs/.vitepress/config.mts
Outdated
| ['link', { rel: "shortcut icon", href: "/favicon.ico", type: "image/x-icon" }], | ||
| ], | ||
| sitemap: { | ||
| hostname: 'https://cancancan.com' |
There was a problem hiding this comment.
assuming this will be the domain
There was a problem hiding this comment.
or maybe cancancan.dev is better?
There was a problem hiding this comment.
this will not only boost the SEO but also helps the user when he searches something on any page since it now gets indexed by google and so
pandermatt
force-pushed
the
feature/add-docs
branch
from
5dd73ec
to
372c544
Compare
pandermatt
commented
Mar 15, 2024
docs/introduction.md
Outdated
Comment on lines
36
to
46
| const members = [ | ||
| { | ||
| avatar: 'https://avatars.githubusercontent.com/u/1319150', | ||
| name: 'Alessandro Rodi', | ||
| title: 'Maintainer', | ||
| links: [ | ||
| { icon: 'github', link: 'https://github.com/coorasse' }, | ||
| { icon: 'twitter', link: 'https://twitter.com/coorasse' } | ||
| ] | ||
| }, | ||
| ] |
|
This work is AMAZING! Thank you @pandermatt. I'll buy cancancan.dev :) |
coorasse
reviewed
May 23, 2024
coorasse
approved these changes
May 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think cancancan could benefit a docs page using vitepress.
VitePress https://vitepress.dev is already used by many others and it allows user to create fast docs page.
You can see a preview at: https://cancancan.pages.dev (i will remove this project so you can claim this name)
for the best experience, the page should be hosted on Cloudflare pages (which is free)