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

Starting point for a website #1114

Merged
merged 6 commits into from
Jan 12, 2022
Merged

Starting point for a website #1114

merged 6 commits into from
Jan 12, 2022

Conversation

cljoly
Copy link
Contributor

@cljoly cljoly commented Jan 2, 2022

  • Create a simple Zola website in a subdirectory
  • Automate website content update from the README.md and existing graphical assets
  • Document how to build and edit the website
  • Deploy automatically to GitHub Pages

What kind of change does this PR introduce?

Did this PR introduce a breaking change?

A breaking change includes anything that breaks backwards compatibility either at compile or run time.

  • No

This uses the [Juice theme](https://www.getzola.org/themes/juice/), with
small customizations. It could be further customized later.
RISS and Makefile are used to pull the website content from various
parts of the neovide repository (reusing images and the README.md file
for instance)
It can be counter-intuitive to have to make changes outside of the
`website` directory, adding documentation and scripting clarify it.
Uses https://github.com/marketplace/actions/zola-deploy-to-pages to
build and deploy the website on GitHub Pages.

TODO (after merging)
* A `TOKEN` need to be set as explained in https://github.com/marketplace/actions/zola-deploy-to-pages#secrets
* I’ve tested with https://cljoly.github.io/neovide/, but we need to
  change this to at least https://neovide.github.io/neovide/.
@cljoly
Copy link
Contributor Author

cljoly commented Jan 2, 2022

See https://cljoly.github.io/neovide/ for a preview.

Things that need to be done right before merge:

  1. Make sure that there is a TOKEN as described in https://github.com/marketplace/actions/zola-deploy-to-pages#secrets

@cljoly
Copy link
Contributor Author

cljoly commented Jan 2, 2022

If we want to have a custom domain, I have neovide.eu.org (free domain managed by an non-profit that nether expires, so low-maintenance), I’m willing to update DNS records as may be needed (and to transfer it, although I’m unsure about the process).

@Kethku
Copy link
Member

Kethku commented Jan 3, 2022

Good point. Another option is I could grab up neovide.dev (or .com) and pay for it with sponsorship money. That way it could be a top level domain.

What do you think?

@Kethku
Copy link
Member

Kethku commented Jan 3, 2022

Can't say enough how awesome this looks btw :) Thanks so much for pushing this forward

@cljoly
Copy link
Contributor Author

cljoly commented Jan 3, 2022

Good point. Another option is I could grab up neovide.dev (or .com) and pay for it with sponsorship money. That way it could be a top level domain.

What do you think?

As you want. .eu.org is in the known public suffix list, so it should behave like say .co.uk. But maybe a .dev is more appealing.

@cljoly
Copy link
Contributor Author

cljoly commented Jan 3, 2022

Can't say enough how awesome this looks btw :)

I've mostly used the defaults of the theme 😉

@Kethku
Copy link
Member

Kethku commented Jan 3, 2022

Maybe I'm just being weird, but I'm not in the EU (or uk) and I know people use neovide from all over, so I'm sorta inclined to get a domain which is location agnostic. Idk if .dev does that or not, but I figure its not a bad way to go

@cljoly
Copy link
Contributor Author

cljoly commented Jan 3, 2022

Maybe I'm just being weird, but I'm not in the EU (or uk) and I know people use neovide from all over, so I'm sorta inclined to get a domain which is location agnostic. Idk if .dev does that or not, but I figure its not a bad way to go

Sure.

@Kethku
Copy link
Member

Kethku commented Jan 3, 2022

Ok I grabbed it up. Its getting late where I'm at, so I'm gonna drop off for now, but this looks good to me :) I see that there is a requirement to add a token. I'll take a look at what that entails soon unless somebody else gets to it sooner.

@cljoly
Copy link
Contributor Author

cljoly commented Jan 3, 2022

Awesome, thanks for the review!

@zoomlogo zoomlogo linked an issue Jan 4, 2022 that may be closed by this pull request
@shaunsingh
Copy link
Collaborator

Looks awesome!

Small nitpick, code blocks for me have a black background but the text itself has a white background. Occurs on macOS 12 on Safari, not sure if other browsers have the issue
image

@cljoly
Copy link
Contributor Author

cljoly commented Jan 9, 2022

Looks awesome!

Thanks!

Small nitpick, code blocks for me have a black background but the text itself has a white background. Occurs on macOS 12 on Safari, not sure if other browsers have the issue image

Yeah, I agree it’s not ideal, it happens to me as well, both on Android and a desktop Linux with a Chromimum-based browser and Firefox.

It should probably be reported upstream to the theme, as it seems to be caused by this CSS:
image

@cljoly
Copy link
Contributor Author

cljoly commented Jan 12, 2022

Shall we set up the token and merge?

I would think the upstream issue with code text is minor enough to be addressed separately.

@Kethku Kethku merged commit 4424731 into neovide:main Jan 12, 2022
@Kethku
Copy link
Member

Kethku commented Jan 12, 2022

Done! I will look into what it will take to target the neovide.dev domain to the new website. Thanks again!

@cljoly
Copy link
Contributor Author

cljoly commented Jan 12, 2022

I'll send a follow up PR to make Zola generate for neovide.dev (and create the CNAME where GitHub pages expects it.)

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.

Create a website
3 participants