Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 1.31 KB

whatis.md

File metadata and controls

25 lines (21 loc) · 1.31 KB
declared 1.0
kind whatis
name declared-md
handle declared-md
headline An open family of standards for self-hosted public profiles
kind_of_project protocol
status alpha
license MIT
language
typescript
markdown
stack
astro
node
github-actions
ajv
maintained_by
guilhermealbert
tags
identity
markdown
open-standard
github
links
repo docs

declared-md is an open family of three Markdown standards for self-hosted public profiles on GitHub. The three standards are whoami.md for individuals, whois.md for organizations, and whatis.md for projects. Each file follows a documented schema, lives in the subject's own repository, and is validated and indexed automatically.

The project has four components: a spec repository with normative documentation and JSON Schemas; a Node.js CLI for generating, validating, and previewing profile files; a GitHub Action that crawls public repositories and aggregates valid files into versioned JSON; and an Astro-based directory site that makes the indexed data browsable and searchable.

The file is the source of truth. The directory is a derived view. Subjects own their data. No platform stores it on their behalf.

In v1.0 the protocol covers GitHub only. The spec is CC0. The tooling is MIT.