From c394c36090e56767f58c20f56d2fbc2d6324de5b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nelson=20Estev=C3=A3o?= Date: Wed, 9 Aug 2023 09:58:54 +0100 Subject: [PATCH] docs: improve section levels --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e52a9e0..6e66fa6 100644 --- a/README.md +++ b/README.md @@ -25,36 +25,42 @@ I have made this into a Jekyll Theme. Checkout the live demo [here](https://onli ## Installation -* [Fork](https://github.com/sharu725/online-cv/fork) the repository -* Go to settings and set master branch as Github Pages source. -* Your new site should be ready at `https://.github.io/online-cv/` +* [Fork](https://github.com/sharu725/online-cv/fork) the repository; +* Go to settings and set master branch as Github Pages source; +* Your new site should be ready at `https://.github.io/online-cv/`; * Printable version of the site can be found at `https://.github.io/online-cv/print`. Use a third party link https://pdflayer.com/, https://www.web2pdfconvert.com/ etc to get the printable PDF. -Change all the details from one place: ``_data/data.yml`` +Change all the details from one place: `_data/data.yml`. -## To preview/edit locally with docker +### To preview/edit locally with docker ```sh docker-compose up ``` -*docker-compose.yml* file is used to create a container that is reachable under http://localhost:4000. +*docker-compose.yml* file is used to create a container that is reachable under . Changes *_data/data.yml* will be visible after a while. ### Local machine * Get the repo into your machine + ```bash git clone https://github.com/sharu725/online-cv.git ``` + * Install required ruby gems + ```bash bundle install ``` + * Serve the site locally + ```bash bundle exec jekyll serve ``` + * Navigate to `http://localhost:4000`