robert/robertjohnson.work
1
1
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix documentation instructions

Browse Source
This commit is contained in:
Nelson Estevão 2023-08-09 09:55:31 +01:00
parent d176347b8c
commit 75a95d756e
No known key found for this signature in database
GPG Key ID: 160B73352C4F1CC7
1 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -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/` * 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. * 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 ## To preview/edit locally with docker
@ -39,7 +39,7 @@ 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 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 ### Local machine
@ -47,10 +47,6 @@ Changes *docs/_data/data.yml* will be visible after a while.
```bash ```bash
git clone https://github.com/sharu725/online-cv.git git clone https://github.com/sharu725/online-cv.git
``` ```
* Go to docs directory
```bash
cd docs
```
* Install required ruby gems * Install required ruby gems
```bash ```bash
bundle install bundle install