aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: c01fa82f0bf88b964f7b6f51db82fde8d9a0f9ae (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# Astrolink-Moe: LinkTree Alternative Template to share about yourself

A derivative of the original [Astrolink](https://github.com/alamguardin/Astrolink) but now more moe

Changes:
- Moe CSS theme added and some layout changes from the original
- You can render custom markdown files by placing markdown files in `public/md` and then visiting `/md?q=MDFileName`

Dynamically rendered markdown demo: https://moekyun.me/md?q=moekyun-social-tos

```sh
git clone https://github.com/pinapelz/astrolink-moe.git
```

![Preview](https://github.com/user-attachments/assets/533f0b94-4739-48b9-a4ab-60679b5d3f37)

## 🚀 How to change the content?

To change the content of the templates, simply locate the ```user.json``` file inside the data folder. You can change the name, profession, and the links you want.

Oh, additionally, you have the entire iconography of [Remixicons](https://remixicon.com/) available. You just need to write the name of the icon within the ```"icon"``` key of each link in the ```user.json``` file.



## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command                   | Action                                           |
| :------------------------ | :----------------------------------------------- |
| `npm install`             | Installs dependencies                            |
| `npm run dev`             | Starts local dev server at `localhost:4321`      |
| `npm run build`           | Build your production site to `./dist/`          |
| `npm run preview`         | Preview your build locally, before deploying     |
| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI                     |
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage