This repo provides a Jekyll site for the https://tech.octopus.energy site. The site is published using Github Pages.
Ensure you have asdf
installed then install Ruby
2.7.8:
> asdf plugin add ruby
> asdf install ruby 2.7.8
> ruby --version # verify
ruby 2.7.8p225 (2023-03-30 revision 1f4d455848) [arm64-darwin23]
Install the github-pages
gem:
> bundle install
Add new posts by creating a markdown file in _posts/
with filename format
YYYY-MM-DD-article-slug.md
(e.g. 2019-02-20-some-article-description.md
). You should also add a header containing
the title and author of the article, amongst other items. For a blog post to appear, the category
must be set to news
. Check existing posts for examples.
Ensure your details are in the _data/members.yml
file.
Preview the appearance by running the local development server with:
make server
which will serve the site at http://localhost:4000.
When the post is ready, submit a pull request and request review from the
@octoenergy/publicity
team.
Once approved, publish by merging your pull-request to master
.
The css/main.scss
SASS file is compiled by Jekyll and served as css/main.css
in the static site.
You can work on site appearance by editing the SASS files in _sass/
and using
the live reload to preview changes.