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

docs: improve section levels

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

18
README.md
View File

@ -25,36 +25,42 @@ I have made this into a Jekyll Theme. Checkout the live demo [here](https://onli
## Installation ## Installation
* [Fork](https://github.com/sharu725/online-cv/fork) the repository * [Fork](https://github.com/sharu725/online-cv/fork) the repository;
* Go to settings and set master branch as Github Pages source. * Go to settings and set master branch as Github Pages source;
* 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: ``_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 ```sh
docker-compose up 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 *_data/data.yml* will be visible after a while. Changes *_data/data.yml* will be visible after a while.
### Local machine ### Local machine
* Get the repo into your machine * Get the repo into your machine
```bash ```bash
git clone https://github.com/sharu725/online-cv.git git clone https://github.com/sharu725/online-cv.git
``` ```
* Install required ruby gems * Install required ruby gems
```bash ```bash
bundle install bundle install
``` ```
* Serve the site locally * Serve the site locally
```bash ```bash
bundle exec jekyll serve bundle exec jekyll serve
``` ```
* Navigate to `http://localhost:4000` * Navigate to `http://localhost:4000`