Skip to content

Commit 8463d6b

Browse files
authored
Update README.md
1 parent 84ffa0f commit 8463d6b

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# agarnung.github.io
22

3-
My (Github) webpage.
3+
My personal website, realized using Jekyll and deployed on GitHub pages. The webpage serves a my portfolio and blog.
44

55
## Instructions for creating a portfolio with Jekyll and Bundler
66

@@ -10,7 +10,7 @@ Follow the official installation instructions for [Jekyll on Ubuntu](https://jek
1010

1111
#### Steps:
1212

13-
1. Install the necessary dependencies:
13+
1. Install the necessary dependencies. [Check this](https://jekyllrb.com/docs/installation/):
1414
```bash
1515
sudo apt-get install ruby-full build-essential zlib1g-dev
1616
```
@@ -33,7 +33,7 @@ If Bundler isn't installed, follow the instructions on [GeeksforGeeks](https://w
3333

3434
Further problems? Keep reading...
3535

36-
### 2) Launch Jekyll and test the website
36+
### 2. Launch Jekyll and test the website
3737

3838
Follow the official instructions to test GitHub Pages sites with [Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll).
3939

@@ -64,7 +64,9 @@ Follow the official instructions to test GitHub Pages sites with [Jekyll](https:
6464
```
6565
5. Open the problematic file _includes/ file and leave it empty to avoid errors while testing locally. Later, when the repository is finished and public, you can add the previous content.
6666

67-
6. Install the dependencies with:
67+
> [!NOTE]
68+
> You can start from step 6 to run my website loclly on your machine, from the cloned repo.
69+
6. Install the dependencies (Ruby gems) with the following command:
6870
```bash
6971
bundle install
7072
```
@@ -77,7 +79,7 @@ Follow the official instructions to test GitHub Pages sites with [Jekyll](https:
7779
bundle exec jekyll serve
7880
```
7981
### Done!
80-
You can now access your website locally at http://127.0.0.1:4000. If you encounter any issues, check the _config.yml and Gemfile, or refer to the official Jekyll documentation.
82+
You can now access your website locally at ```http://127.0.0.1:4000```. If you encounter any issues, check the _config.yml and Gemfile, or refer to the official [Jekyll documentation](https://jekyllrb.com/docs/installation/).
8183

8284
A typicall organized structure of a Jeckyll project may be something like this:
8385
```
@@ -97,12 +99,22 @@ A typicall organized structure of a Jeckyll project may be something like this:
9799
└── _site/ # Output generated by Jekyll (DO NOT EDIT)
98100
```
99101

102+
This webite is deployed with [Github pages](https://docs.github.com/en/pages/quickstart). Nevertheless, there are many other ways to deploy Jekyll websites remotely, check [this](https://jekyllrb.com/docs/deployment/third-party/#:~:text=Sites%20on%20GitHub%20Pages%20are,Jekyll%2Dpowered%20website%20for%20free.).
103+
100104
### Troubleshooting
101105
* Can't see my favicon?: Clear Cache. Try a hard refresh (Ctrl + F5 or Cmd + Shift + R) or open in incognito mode. Browsers often cache favicons aggressively, and sometimes a simple refresh won't show the new favicon.
102106

103107
### Licence
104108
This portfolio is based on th awesome template [portfolYOU](https://github.com/yousinix/portfolYOU).
105109

110+
Changes made to fulfil my needs:
111+
* Separate timeline in two different trees.
112+
* Changed the [Error 404](https://codepen.io/code2rithik/pen/PoWQYGa) page
113+
* Added script to list repos through Github API
114+
* Added theme colors for skills
115+
* Edited main page layout
116+
* Changed footer, header and other includes
117+
106118
<div align="center">
107119
<sub><sup>© 2025 Alejandro Garnung Menéndez, licensed under the <a href="./LICENSE">MIT License</a>.</sup></sub>
108120
</div>

0 commit comments

Comments
 (0)