SocialSpec

SocialSpec lets feed readers and social apps turn your site into a full profile, without scraping your HTML. Next to your feeds, Lamb serves three small files under /.well-known/. Each one is built from something you already set up, and stays switched off (404) until you do.

Path Spec Built from
/.well-known/about.md AboutSpec Your page with the slug about
/.well-known/contact.vcf ContactSpec author_name, author_email, your site URL and profile links
/.well-known/following.opml FollowSpec A copy of the list at following_url

All three can be read from other sites (CORS), and support conditional requests, so apps can check for changes cheaply.

About

Publish a page with slug: about:

---
title: About me
slug: about
summary: Web engineer writing about Linux tooling.
---
I write short notes about…

about.md serves the page’s Markdown with its title as a heading. The summary comes from the page’s summary (or description), and falls back to site_description. Links and images that start with / are made absolute, except inside code. Adding the page as a menu item (About = about) keeps it out of your timeline.

Contact

Set author_email in site configuration. The vCard lists that address, your author_name (or site_title), your site URL, and every http(s) link in profile links. Without an author_email, there’s no contact file.

Following

Lamb doesn’t keep a list of who you follow. Your feed reader does, so Lamb copies its list instead of making you maintain a second one. Enter its public OPML address in the Following list field at /settings, for example https://reader.example/following/your-token.opml.

The scheduled tasks fetch that URL at most every 30 minutes and serve the copy from your own domain. If the reader is down, or returns something that isn’t OPML, the last good copy stays. Clear the following list field and the file goes away.

Use a list your reader publishes on purpose. It will be public on your site.


This site uses Just the Docs, a documentation theme for Jekyll.