OS Component Template is a project that aims to greatly simplify creating a website for your project. It aims to let you write simple markdown pages and deploy the simple Zola project to gitlab or github.
Originally built with Jekyll, the template has been ported to Zola -- a single static binary with no dependencies. Builds are near-instant and there's no Ruby/gem dependency hell to deal with.
Edit a bit of metadata and tweak some of the included graphics and have a site up in minutes!
- Proper favicon for modern browsers and Apple device icons
- Twitter, Facebook and other social media meta cards for easy sharing. Try Share Preview to test.
- Local copy of the amazing Inter font. No slowdowns pulling from external hosting.
- Mobile friendly, dark variant included.
Setup
The process of setting up the site locally consists of:
-
Install Homebrew if you don't have it already. It's a package manager that works on Linux, macOS and WSL, making it the easiest way to install tools like Zola regardless of your platform.
-
Install Zola:
brew install zola
cd os-component-website
zola serve
Other installation methods are available on the Zola installation page, and some distributions (such as Arch Linux) ship Zola in their repositories.
-
Edit the Zola config file --
config.toml. -
Replace or edit all the graphics. I recommend using Inkscape. If you want to shave off some kB out of the SVGs, use svgo.
-
Test the site locally:
zola serve
git commityour changes and push to your remote repo for automatic deployment. There is an included.gitlab-ci.ymlthat should be easy to adjust to your gitlab hosting situation. For github pages situation, see these instructions.
Alternatively you can be wild and edit the site directly on github using the remote VSCode editor by pressing . after cloning the repo. Right in the browser. It's insane.
Written with love using Apostrophe.