Personal Links

A fast, accessible, self-hosted link-in-bio site — minimal, responsive, and easy to maintain.
View Demo »

Report Bug · Request Feature

View Contents

Last Updated 1 September 2025

• About The Project
  • Features
  • Built with
• Getting started
  • Prerequisites
  • Install
  • Usage
• Back Matter
  • Roadmap
  • Contributing
  • License

About The Project

Personal Links is a lightweight link-in-bio site you can host yourself. It focuses on performance, accessibility, and a simple editing workflow so you can keep your public links up to date without fuss.

(back to top)

Features

• ⚡ Fast & responsive by default (mobile-first, lighthouse-friendly)
• ♿ Accessible structure and semantics
• 🧩 Simple content model — keep links in one place, easy to edit
• 🌓 Dark/light mode friendly styling
• 🔍 SEO-ready metadata & share cards (Open Graph)
• 🚀 Easy deploys to Vercel/GitHub Pages (static export supported)

Built with

• Next.js & TypeScript
• Tailwind CSS
• PNPM
• Vercel (recommended deploy target)

(back to top)

Getting started

Prerequisites

• Node.js 18+ (20+ recommended)
• PNPM installed (npm i -g pnpm) — or use NPM/Yarn if preferred

Install

# 1) Clone
git clone https://github.com/smcnab1/personal-links.git
cd personal-links

# 2) Install deps
pnpm install

# 3) Run locally
pnpm dev

Optional environment variables (if you add analytics or custom meta) can be placed in .env.local.

Usage

• Add or edit links: update your links data/component in src/ (e.g. a links.ts or the relevant section in your page component).

• Branding: replace images in images/ and public/ (e.g. avatar, social preview).

• Build & Export:

  pnpm build && pnpm start        # production server
  # or, for static export if configured:
  pnpm build && pnpm export

• Deploy: deploy the repo to Vercel (zero-config) or serve the static export via GitHub Pages/another host.

(back to top)

Back Matter

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are welcome — thank you! If you have suggestions, please open an issue (use the enhancement or feature-request labels) or submit a PR.

1. Fork the project
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m "feat: add amazing feature")
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License.

(back to top)