before starting, please install the following programs:
for ease of use, also install:
- vs code
- tailwind extension inside vscode
to get working for the first time:
- clone repo
- open a terminal in the repo folder (in vscode: open folder > sumo-website > terminal > new terminal)
bundle install
(installs jekyll, webrick and all the required ruby gems)npm install
(installs tailwind, flowbite and all the nodejs dependencies)- to start editing,
bundle exec jekyll serve --livereload
-- a message should print sayingserver address: http://127.0.0.1:4000
or another address. hold ctrl and click on it to open in a browser. - every commit refreshes the webpage on github pages using the .yml workflow in the .github/workflows folder. allow for one minute after commiting for changes to be reflected. check the actions tab if it fails.
- all blog posts sit in the
_posts
folder. add a new file using the format<yyyy>-<mm>-<dd>-<title>.md
, for example2022-01-01-happy-new-year.md
. - inside every blog post, fill out the front matter (the text in between the dashed lines):
---
layout: post
title: New Website!
author: rydrako
---
- most times only title and author need to be edited.
- the text inside every blog post uses markdown formatting, please check the markdown cheat sheet for more info.