Skip to content

Slate let's you write & share information without storing them on any server! All data is contained in the URL itself and is dynamically rendered when viewing.

License

Notifications You must be signed in to change notification settings

iamshouvikmitra/slate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open Source Love Open Source Love PRs Welcome

Slate 📝

Slate Notes takes html (or other data), compresses it into a URL fragment, and provides a link that can be shared. When it is opened, it renders that data on the receiver’s side. Its live here.

About

Slate Notes are contained entirely within their own link. (Including this one!) This means they're...

💼 Portable - you don't need a server to host them
👁 Private - nothing is sent to–or stored on–this server
🎁 Easy to share as a link or QR code

Slate Notes can hold about as much as a printed page, and there is a lot you can do with that:
✒️ Compose poetry
🛠 Create an app
🐦 Bypass a 140 280 char limit
🎨 Express yourself in ascii

Hosting

One simple way to host is to forward a domain. Just paste your slate's url in the redirect.

Technical Details

How it Works

  1. Data Flow

    • Content is compressed using LZMA with maximum compression (level 9)
    • Compressed data is converted to base64
    • Base64 is made URL-safe by replacing special characters
    • Final URL contains everything needed to render the content
  2. Compression

    • Uses LZMA (Lempel-Ziv-Markov chain Algorithm)
    • Typically achieves 30-50% better compression than gzip
    • Maintains UTF-8 encoding for emojis and special characters
    • Allows for longer content in URLs
  3. Features

    • Client-side compression and decompression
    • No server storage needed
    • Mobile-friendly with native sharing
    • QR code generation for easy mobile sharing
    • Supports text formatting and emojis
  4. Size Limits

    • Title: 100 characters
    • Content: 5000 characters
    • Compressed size varies based on content type
  5. Browser Support

    • Modern browsers (Chrome, Firefox, Safari, Edge)
    • Requires JavaScript enabled
    • Uses Web Share API on mobile when available
    • Falls back gracefully for older browsers

Architecture

Content → LZMA Compression → Base64 Encoding → URL-safe Characters → Shareable URL

Contributions

Feel free to open a pull request adding your new features, resolving issues, cleaning code or making this readme super awesome 😎

Screenshot.

Nothing Special, but here it is.

License

Slate Notes is covered by the MIT License.
Copyright (C) 2018 - 2025 ~ Shouvik Mitra ~ [email protected]

Inspiration

This website is an inspiration from itty.bitty.site

About

Slate let's you write & share information without storing them on any server! All data is contained in the URL itself and is dynamically rendered when viewing.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published