This template is based on WhatATheme, a customizable Jekyll portfolio theme.
The contents of this repo represent the expected end result from a workshop entitled Creating a Tech Writing Portfolio with Docs as Code Tooling by slavipande.
You’ll need a few things so you can follow along the steps of the workshop. Here’s a list of them and more info how to install them.
git version
to check if you already have it installed. You should get a version number in response.jekyll -v
to check if you already have it installed. You should get a version number in response.See Creating a Tech Writing Portfolio with Docs as Code Tooling - Preliminary Setup for detailed instructions how to install everything you'll need.
Fork this repo.
Clone your fork locally.
git clone https://github.com/<your-github-username>/Workshop-TechWritingPortfolio.git
Run bundle install
in your local project folder.
You must have Jekyll installed before running this command --> Go back to Preliminary Setup.
Run bundle exec jekyll serve
in your local project folder.
You should see your local Jekyll server running at
http://127.0.0.1:4000
.
Play around with the site settings to get a feeling which setting controls what. Don't forget to push your local changes to your GitHub repo when done.