https://github.com/gabsedits/quick-links
An easy way to access your quick links from anywhere in the world
https://github.com/gabsedits/quick-links
Last synced: 3 months ago
JSON representation
An easy way to access your quick links from anywhere in the world
- Host: GitHub
- URL: https://github.com/gabsedits/quick-links
- Owner: GabsEdits
- License: mit
- Created: 2024-03-31T14:18:13.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-03T20:24:47.000Z (over 1 year ago)
- Last Synced: 2025-03-03T21:28:04.243Z (over 1 year ago)
- Language: Vue
- Homepage: http://lab.gxbs.dev/quick-links/
- Size: 201 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Quick Links
An easy way to access your quick links from anywhere in the world, securely.
Powered by VitePress
## Intention
I created this project to have a convenient and straightforward page for
organizing my school projects and files.
## Usage
To edit the cards and links, you can modify the `index.md` file. Inside the
file's frontmatter, you will find a JSON array that represents the cards. Each
card has properties such as subject, details, date, and color. You can duplicate
or modify any of these cards to suit your needs.
### Links
To set up the links, follow these steps:
1. Rename the `.env.example` file to `.env`.
2. Inside the `.env` file, locate the `VITE_PASSWORD_KEY` variable. This
variable represents the password key. Change the value to a secure password
key of your choice.
3. Below the `VITE_PASSWORD_KEY` variable, you will find multuple `VITE_LINKx`
variables, where `x` is a number. These variables correspond to the secret
links for your cards, in the same order as in the `index.md` file.
Make sure to update the values of the `VITE_LINKx` variables with the desired
secret links for your cards.
Once that is done, head over to the `index.md` file and update each card with
the corresponding details and make sure it's in the same order as the
`VITE_LINKx` variables in the `.env` file.
```yml
---
cards:
- subject: Math
details: Some Big Problem
date: 00/00/3000
color: "rgba(255, 0, 0, 0.484)"
- subject: English
details: Some Grammar Article
date: 01/10/0101
color: "rgba(255, 102, 0, 0.484)"
- subject: English
details: Verbs and Nouns
date: 10/00/1010
color: "rgba(255, 247, 0, 0.484)"
- subject: Tech
details: The Fediverse and You
date: 22/38/0231
color: "rgba(0, 89, 255, 0.269)"
---
```
The `color` property is a CSS color value that represents the card's background
color. You can customize this value to any color you like, using `rgba`, `hex`,
`hsl`, or any other CSS color format.
The `subject`, `details`, and `date` properties are self-explanatory and can be
customized to your liking. The `date` and `details` properties are optional and
can be removed if not needed.
There is no limit to the number of cards you can add to the `index.md` file. You
can add as many cards as you like, and they will be displayed on the page.
### Other Options
You can also customize the project's title, description, and copyright by
modifing the `config.mts` file isside the `.vitepress` directory:
#### Copyright
```javascript
themeConfig: {
copyright: true,
author: {
name: "Your Name",
link: "https://example.org/",
},
}
```
## Development
The Quick Links project is built using VitePress, a powerful Static Site
Generator. With VitePress, you can easily build and run the project locally.
#### Install Dependencies
> [!NOTE]
> Make sure to have [Node.js](https://nodejs.org) and [PNPM](https://pnpm.io)
> installed on your machine.
To get started, navigate to the project directory in your terminal and run the
following command to install the project dependencies:
```bash
pnpm install
```
#### Run Development Server
To run the development server locally and see live changes, use the following
command:
```bash
pnpm dev
```
#### Run Production Build
To build your project for production, use the following command:
```bash
pnpm build
```
This command will generate optimized and minified files that are ready to be
deployed to a production environment.