Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 2.07 KB

index.md

File metadata and controls

46 lines (31 loc) · 2.07 KB
Raw
layout
default

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 jekyll project to gitlab or github.

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:

toolbox enter
sudo dnf install rubygem-bundler
cd os-component-website
bundle install

  • Edit the Jekyll config file --_config.yml.

  • 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:

bundle exec jekyll s
  • git commit your changes and push to your remote repo for automatic deployment. There is an included .gitlab-ci.yml that 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.