Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abranhe/git-dot-io
[DEPRECATED] Redirect URLs to your websites using @github URL Shortener
https://github.com/abranhe/git-dot-io
git-io gitdotio hacktoberfest redirect url-shortener
Last synced: 23 days ago
JSON representation
[DEPRECATED] Redirect URLs to your websites using @github URL Shortener
- Host: GitHub
- URL: https://github.com/abranhe/git-dot-io
- Owner: abranhe
- License: unlicense
- Created: 2017-11-11T05:27:22.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T01:13:12.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T12:15:28.933Z (about 1 month ago)
- Topics: git-io, gitdotio, hacktoberfest, redirect, url-shortener
- Language: JavaScript
- Homepage: https://git.io/gitdotio
- Size: 1.74 MB
- Stars: 16
- Watchers: 1
- Forks: 70
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
#### The documentation is not up to date.
> To add a new redirect, you need to add it on `data/redirect.json`
Redirect to your websites using git.io
## Why?
[**Git.io**](https://git.io) is a URL shortening service that will redirect to your **Github** projects. If you try to redirect to other domain out of `Github.com` (*like your website*) you won't be able to do it.
So [this project](https://github.com/gitdotio/gitdotio.github.io) will help you redirect to any website using **git.io** super easy!
## How to do it?
- Check if [git.io/YOUR-BEAUTIFUL-LINK](https://git.io/your-beautiful-link) is avilable.
- Go to **[_redirects](_redirects)**.
- Create an **.html** file with the name of the link you want to make.
- Inside the file you need to copy the code below and paste it on you file, change it with you content.
``` html
---
permalink: /your-beautiful-link
destination: http://your-beautiful-site.com
---
```
### So is that all?
> No!
Now you can go to [**Git.io**](https://git.io) and copy `gitdotio.github.io/your-beautiful-link` and paste your link there and when you are done, you will have a `git.io/random-name` that will be redirected to `your-beautiful-site.com`.
**Cons**:
The [**Git.io**](https://git.io) website will only offer random short URLs.
## So what if I want a `mycool-name`?
Well to have your custom vanity URL with **git.io** you will need to use your command line.
```console
$ curl -i https://git.io -F "url=https://gitdotio.github.io/your-beautiful-link" -F "code=mycool-name"
```
where you will need to set the `url=` parameter with the link created by **gitdotio.github.io** and `code=` with the value you'd like to set.
At this point when you type `git.io/mycool-name` that will be redirected to `your-beautiful-site.com`
## Note ⚠️
Websites won't be checked, but keep in mind to don't redirect to any abusive, racist or sexist website.
To use this service since it's owned by **Github, Inc** you will need to agree with the following:
- [x] Github's [Term and conditions](https://github.com/site/terms)
- [x] Github's [Privacy](https://github.com/site/privacy)
- [x] Github's [Security Terms](https://github.com/security)
## Who to follow?
|[](https://github.com/abranhe)|
| :-: |
| [Abraham Hernandez](https://github.com/abranhe) |
## License
[The UNLICENSE](https://github.com/gitdotio/gitdotio.github.com/blob/master/license)