47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
|
|
|
|
---
|
|
|
|
[Live demo](https://example.treelink.app)
|
|
|
|
[Online tool](https://treelink.app)
|
|
|
|
[Documentation](https://treelink.app)
|
|
|
|
## 🚀 Getting started
|
|
|
|
```bash
|
|
# Run this in your terminal...
|
|
npm init astro -- --template trevortylerlee/treelink treelink-test
|
|
|
|
# ... or read the quick start guide...
|
|
# https://docs.treelink.app/guides/quick-start/
|
|
|
|
# ... or watch on YouTube
|
|
# https://youtu.be/3-eALOdm-3s?si=o6O3_Ackrbp0gkLH
|
|
```
|
|
|
|
## ✨ Features
|
|
|
|
- Customizable, with premade themes for light and dark mode
|
|
- Custom OpenGraph images per post, with a fallback image
|
|
- Icon support for hundreds of sites
|
|
- RSS and sitemap generation
|
|
- Optional blog
|
|
- Web vitals: 100 100 100 100
|
|
|
|
## 🧞 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:3030` |
|
|
| `npm run build` | Build your production site to `./dist/` |
|
|
| `npm run preview` | Preview your build locally, before deploying |
|
|
|
|
## 👀 Want to learn more?
|
|
|
|
Feel free to check [Astro's documentation](https://github.com/withastro/astro) or jump into Astro's [Discord server](https://astro.build/chat).
|