Skip to content

Commit

Permalink
docs: fix documentation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
nelsonmestevao committed Aug 9, 2023
1 parent d176347 commit 75a95d7
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ I have made this into a Jekyll Theme. Checkout the live demo [here](https://onli
* Your new site should be ready at `https://<username>.github.io/online-cv/`
* Printable version of the site can be found at `https://<username>.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: ``docs/_data/data.yml``
Change all the details from one place: ``_data/data.yml``

## To preview/edit locally with docker

Expand All @@ -39,18 +39,14 @@ docker-compose up
```

*docker-compose.yml* file is used to create a container that is reachable under http://localhost:4000.
Changes *docs/_data/data.yml* will be visible after a while.
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
```
* Go to docs directory
```bash
cd docs
```
* Install required ruby gems
```bash
bundle install
Expand Down

0 comments on commit 75a95d7

Please sign in to comment.