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

Add video to homepage hero #26

Merged
merged 8 commits into from Mar 10, 2023
Merged

Add video to homepage hero #26

merged 8 commits into from Mar 10, 2023

Conversation

karlhorky
Copy link
Collaborator

@karlhorky karlhorky commented Sep 14, 2022

Hey @Newbie012 👋 Just a quick PR adding the video from your tweet (not working yet!)

video.mp4

Ah, I guess VitePress's default theme's home layout doesn't support HTML in there (see screenshot below): vuejs/vitepress#1340

Hm, I'm not entirely sure what to do here. Happy to follow some suggestions!

Alternative: Switch out the large logo for a GIF instead... 🤔 VitePress would support this

Screen Shot 2022-09-14 at 18 19 47

@vercel
Copy link

vercel bot commented Sep 14, 2022

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

Name Status Preview Comments Updated
safeql ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Mar 10, 2023 at 10:15AM (UTC)

@karlhorky
Copy link
Collaborator Author

@Newbie012 any opinion on this here?

In vuejs/vitepress#1340 they say that they would like to support a video, but who knows when this feature will appear.

Maybe we could still add a video (screen recording) on the homepage in the meantime? I think it would show quickly and simply what SafeQL does. Even just using your original video from the tweet would be a great start!

@Newbie012
Copy link
Collaborator

I like the idea, although I think we should show a simpler and shorter videos with higher quality (the one in Twitter has a quite poor quality) that still emphasizes the power of this tool.

There's this tweet as well - https://twitter.com/CoEliya/status/1570051268294463490?s=20&t=zn3SAQUNODabhAgat7aN1A

@karlhorky
Copy link
Collaborator Author

karlhorky commented Sep 17, 2022

Ok good, sounds fine to me. Is this second Twitter video good enough in your opinion? Do you have the original file at a higher quality still?

Do you know VitePress well? (eg. creating a custom theme / layout based on the home layout) If not, do you have an alternate suggestion for how we can add a video to the homepage?

@Newbie012
Copy link
Collaborator

We have a few options:

  1. Wait for vitepress for official support.
  2. Copy and edit https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/components/VPHero.vue and then use it instead.
  3. Add the video to the bottom of the page.

Since I'm not in a hurry, then I wouldn't mind going with option one.

I think I have the original video with a higher quality.
I'll have to check.

@karlhorky
Copy link
Collaborator Author

Seems like VitePress supports this now!

Although I'm not super familiar with VitePress and extending slots - not sure exactly how to implement this. I've asked in vuejs/vitepress#1340 (comment)

@changeset-bot
Copy link

changeset-bot bot commented Mar 10, 2023

⚠️ No Changeset found

Latest commit: 26c3ebb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@karlhorky
Copy link
Collaborator Author

@Newbie012 Added a Layout.vue according to the recommendation by @brc-dd over here:

Maybe ready for review now?

@karlhorky
Copy link
Collaborator Author

karlhorky commented Mar 10, 2023

Oh, the deploy preview for that does not show the video, did I do something wrong?

Screenshot 2023-03-10 at 10 48 57

I thought it would take place of the image on the right. Or maybe VitePress 1.0.0-alpha.13 is too old and needs to be updated? 🤔

@brc-dd
Copy link
Contributor

brc-dd commented Mar 10, 2023

@karlhorky Update lock files too.

@karlhorky
Copy link
Collaborator Author

Ok, CI is passing now, not sure what needs to be done to trigger another deploy...

@brc-dd
Copy link
Contributor

brc-dd commented Mar 10, 2023

A recommendation: Split tagline (docs/index.md) to multiple lines (currently it's overlapping with the video):

  tagline: |
    An ESLint plugin for writing SQL queries
    in a type-safe way.

Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
@karlhorky
Copy link
Collaborator Author

Looks like it's working, thanks!! Thanks for the help and improvements @brc-dd ! 🙌

Kapture.2023-03-10.at.11.13.22.mp4

@brc-dd
Copy link
Contributor

brc-dd commented Mar 10, 2023

Cool, sorry for the delay in replying on that thread.

@karlhorky
Copy link
Collaborator Author

No worries, thanks for getting back to it!

@Newbie012
Copy link
Collaborator

Thanks everyone , it looks great 😃

@Newbie012 Newbie012 merged commit 5fd5206 into ts-safeql:main Mar 10, 2023
@karlhorky karlhorky deleted the add-video-to-homepage branch March 10, 2023 10:54
@karlhorky
Copy link
Collaborator Author

Glad to help, thanks for the review and merge!

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.

None yet

3 participants