Skip to main content

A modern, brutalist-designed static site generator for link bio pages

Project description

LinkBioSite

PyPI version Python 3.8+ License: MIT GitHub stars GitHub forks

A modern, brutalist-designed static site generator for creating beautiful link bio pages. Features 2026 design trends with cosmic midnight color palettes, experimental layouts, and smooth animations.

✨ Features

  • 🎨 Brutalist Design: Cosmic midnight color palette with experimental layouts
  • Motion Design: Scroll-triggered animations, hover effects, and micro-interactions
  • 📝 Dynamic Typography: Text reveals, floating elements, and responsive animations
  • 📱 Mobile-First: Optimized for all devices with clean, accessible interfaces
  • Static Generation: Fast, lightweight sites with no runtime dependencies
  • 💻 CLI Interface: Easy-to-use command-line tools for development and deployment
  • 🐳 Docker Support: Containerized builds for consistent deployment
  • 🔒 Type-Safe: Full type hints and modern Python practices

🚀 Quick Start

Installation

Install LinkBioSite from PyPI:

pip install linkbiosite

Or install from source:

git clone https://github.com/rafnixg/links.git
cd links
pip install -e .

Create Your First Site

  1. Initialize a new project:

    linkbiosite init
    
  2. Edit your data in data.json:

    {
      "name": "Your Name",
      "bio": "Your bio here",
      "links": [
        {"title": "Website", "url": "https://example.com"},
        {"title": "Twitter", "url": "https://twitter.com/username"}
      ]
    }
    
  3. Build your site:

    linkbiosite build
    
  4. Serve locally:

    linkbiosite serve
    

Your site will be available at http://localhost:8000

📖 Usage

Command Line Interface

linkbiosite --help          # Show help
linkbiosite init            # Initialize new project
linkbiosite build           # Build static site
linkbiosite serve           # Serve locally for development

Python API

from linkbiosite import LinkBioSiteGenerator

# Create generator
generator = LinkBioSiteGenerator()

# Build site
generator.build_site()

🏗️ Project Structure

After running linkbiosite init, your project will look like:

your-project/
├── [`data.json`](data.json )          # Your profile data
├── templates/         # Custom templates (optional)
│   ├── base.html
│   ├── index.html
│   └── styles.css
└── public/            # Generated site (after build)
    ├── index.html
    └── styles.css

🎨 Customization

Templates

LinkBioSite uses Jinja2 templates. Customize by modifying files in the templates/ directory.

Styling

Edit templates/styles.css to customize the brutalist design. The default theme features:

  • Cosmic midnight color palette (#0a0a0a, #ffffff, #ff6b6b)
  • Experimental typography with glow effects
  • Smooth animations and transitions

Data Format

Your data.json supports:

{
  "name": "Your Name",
  "bio": "Short bio",
  "avatar": "path/to/avatar.jpg",
  "links": [
    {
      "title": "Link Title",
      "url": "https://example.com",
      "icon": "optional-icon-class"
    }
  ],
  "social": {
    "twitter": "@username",
    "github": "username"
  }
}

🐳 Docker

Build and run with Docker:

# Build image
docker build -t linkbiosite .

# Run container
docker run -p 8000:8000 linkbiosite

🧪 Development

Setup Development Environment

git clone https://github.com/rafnixg/links.git
cd links
pip install -e ".[dev]"

Run Tests

pytest

Code Quality

black .          # Format code
isort .          # Sort imports
flake8 .         # Lint code
mypy .           # Type check

📚 Documentation

Full documentation is available at https://linkbiosite.readthedocs.io/

🤝 Contributing

Contributions are welcome! Please see our Contributing Guide for details.

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests
  5. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Built with Jinja2 templating
  • Inspired by modern web design trends
  • Community contributions and feedback

📞 Support


LinkBioSite - Create stunning link bio pages with modern design ✨

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

linkbiosite-3.1.0.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

linkbiosite-3.1.0-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file linkbiosite-3.1.0.tar.gz.

File metadata

  • Download URL: linkbiosite-3.1.0.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for linkbiosite-3.1.0.tar.gz
Algorithm Hash digest
SHA256 aed03b318c04ea3c3c9cccff35a31de85ba018b8b6d5917119a931630e2f4edf
MD5 7e44a0f047cf022fd907462892c5c3a5
BLAKE2b-256 796de4a5a39d429ef8901dbf00b2b7b5f75c9fa24bba2d6672619ba96ca3bb19

See more details on using hashes here.

File details

Details for the file linkbiosite-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: linkbiosite-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for linkbiosite-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a7c6f12f0abf512251fd2855f5cfb7afa6c3a0341ea01f4e15013db435f58a22
MD5 09e83286e457ed411a0edac7cf655aa8
BLAKE2b-256 8a0455c003a90c84a24fbcf4e66082deec74290b42de1a51a83f391e846ba855

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page