# [Links](https://github.com/harsh98trivedi/Links)
A Beautiful Jekyll Theme For Links
### Screenshot
### Checkout the [Demo Here](https://harsh98trivedi.github.io/links)
---
## Installation
### System Requirements
- [Ruby](https://www.ruby-lang.org/en/)
- [Jekyll](https://jekyllrb.com/) (You can read **What is Jekyll [here](https://github.com/jekyll/jekyll#jekyll)**)
- [NPM](https://npmjs.com/)
### Up and Running
- Fork this [Repository](https://github.com/harsh98trivedi/Links)
- Edit the **_config.yml**
- Fill the available details accordingly
- Commit the changes
> Links is also [**Netlify**](https://www.netlify.com/) ready. ✅
You can checkout the netlify version up and running [**here**](https://htlink.netlify.app/).
### Want to set this up **locally**?
- Clone this **Repository** using **Git**
> Kindly Change [USERNAME] with your own GitHub UserName
``` git
git clone https://github.com/[USERNAME]/Links
```
- Go to the project directory
```bash
cd links
```
- Install **Links** with **npm**
``` bash
npm start
```
---
### Want to set this up on **Docker**?
View repository on [Docker Hub](https://hub.docker.com/r/harsh98trivedi/links)
- Edit your **_config.yml**
- Fill in the available details accordingly
- Run the **Docker** container:
```bash
docker run -d -p 4000:4000 -v /absolute/path/to/_config.yml:/app/_config.yml --name links harsh98trivedi/links:latest
```
- Open the browser and go to **links-ip:4000**. You should see your **links** site up and running!
> Note: Whenever you make changes to the **_config.yml** file, you need to stop and remove the **Docker** container, then recreate it:
```bash
docker stop links && docker rm links && docker run -d -p 4000:4000 -v /absolute/path/to/_config.yml:/app/_config.yml --name links harsh98trivedi/links:latest
```
## Content Credits
- [Cover Image](https://source.unsplash.com/)
- [Font Awesome](https://fontawesome.com/)
- [Poppins Font](https://fonts.google.com/specimen/Poppins)
- [Images.weserv.nl](https://images.weserv.nl/)
---
Special Thanks to [Rohit Motwani](https://github.com/rohittm) for configuring **Nodemon** and making it up and running with his geeky mind, [Hitanshu Sahu](https://www.behance.net/phantomcluster) for improving the design with his awesome UI skills and [Nelson Dane](https://github.com/NelsonDane) for making this compatible with [Docker](https://docker.com/)
### License
The contents of this repository are licensed under the [GNU General Public License v2.0](https://github.com/harsh98trivedi/Links/blob/master/LICENSE)
[](https://app.netlify.com/sites/htlink/deploys)
