An awesome, function website for an awesome, functional font — Lexend is a font designed specifically to increase to reading-proficiency, and it's got some data to back it up. We designed this sucker to show it.
There's a lot of fun but not-too-complicated tech here:
- next.js for a minimal react framework
- react-spring for amazing animation
- emotion for simple & mostly-contained component styling
- mdx to keep our homepage in fairly simple markdown, with components mixed in
Make sure you've got Node installed, cuz we usin' JavaScript. I prefer yarn to install dependencies, but npm works, too. You just need one or the other — the commands are the same, switch
yarnwithnpmif that's what you've got.
The website is ultimately generated & committed with special requirements to make it work with Github Pages, so the you can think of the website branch as the source code for the site, and the gh-pages branch as minified distribution code — you won't ever really need to touch the gh-pages branch manually.
- Checkout the
websitebranch & install dependencies so you can run locally:
git checkout website
yarn install- Run locally:
yarn dev- To make changes, create a new branch based off the
websitebranch, make your changes, and push. You can make a pull request on Github, which if accepted will get merged into thewebsitebranch. - Once a pull request is merged, you'll have to pull changes from the website branch down to your local machine in order to generate & deploy to the
gh-pagesbranch.
git pull --all
git checkout website
yarn deployThe deploy command simplifies the gh-pages deploy process using the lovely gh-pages library, which is included in the development dependencies when you yarn install and uses git behind the scenes.
It will do all the work for you of generating the final site code (yarn predeploy is run automatically behind the scenes when you run yarn deploy) & pushing it to the correct branch (which is what yarn deploy does).
Github Pages sometimes takes a minute or two to clear the cache on Github's end after deploying, but you won't ever need to do anything beyond running yarn deploy locally when you have the website branch up-to-date to get your changes live.
One gotcha (which you might notice in package.json on #master and shouldn't have to worry about if you use as-is), is that we have to pass the -t argument, which is shortcode for including dotfiles — gh-pages ignores folders that start with an _ if you don't include a .nojekyll file, and we're making sure to include that shnaz in the predeploy command that gets automatically run when you hit yarn deploy.
The /static folder is an important part of Next.js, and where we store all our non-dynamic files like fonts, images, etc. Because gh-pages is running in a subdirectory (lexend-com.github.io/lexend instead of just lexend-com.github.io/website or lexend.com), we have to change the URLs for static files to match whatever directory it's living in.
You'll notice all the static files are absolute URLs, just to make it simple. If you change where this lives, you'll want to do a find & replace to update those static files. There aren't a lot.