Velohost Velohost

Astro Integration

Astro Humans

Generate a clean, human-readable humans.txt file for Astro sites at build time — because the internet is for humans.

Last Updated: 01 April 2026

Usage Snapshot

43

Downloads in Last 30 Days

v1.0.1

Latest npm Version

Source: npm registry

Why This Plugin Exists

humans.txt is a courtesy file that documents the people and tools behind a website. It is not a legal document, ownership claim, or enforcement mechanism.

Astro Humans generates a deterministic humans.txt file at build time using a minimal, user-owned configuration file.

The plugin is intentionally non-opinionated, adds no runtime logic, and fails silently when configuration is missing or disabled.

Design Principles

  • Build-time only — zero runtime middleware or scripts
  • Fail-silent behaviour — no output if config is missing or disabled
  • Non-opinionated and human-first
  • Deterministic output on every build
  • No tracking, telemetry, or ownership claims

What This Plugin Delivers

  • Generates a human-readable humans.txt file
  • Supports automatic migration from legacy config locations
  • Deterministic output with safe normalisation
  • Optional /.well-known output
  • No schema enforcement beyond basic safety

Installation

npm install astro-humans

On first run, the plugin ensures config-files/humans.config.json exists and migrates legacy root configs automatically.

FAQs

What does the Astro Humans plugin do?

Astro Humans generates a clean, human-readable humans.txt file at build time for Astro sites using a simple configuration file.

Where is humans.txt written?

The file is written to /humans.txt by default, with optional output to /.well-known/humans.txt if enabled.

Implementation FAQs

What is humans.txt?

humans.txt is a courtesy file that documents the people and tools behind a website. It is not a legal or technical enforcement mechanism.

Does Astro Humans run at runtime?

No. Astro Humans runs exclusively at build time and adds no runtime middleware, scripts, or client-side logic.

Where is the configuration file stored?

On first run, the plugin ensures config-files/humans.config.json exists. Legacy root configs are migrated automatically.

Does Astro Humans migrate older configurations?

Yes. If a legacy humans.config.json exists in the project root, it is moved once to config-files/ without overwriting existing files.

What happens if the configuration is missing or invalid?

The plugin fails silently. No humans.txt file is generated and the build continues normally.

Is there a required schema?

No. All sections are optional and omitted if empty. There is no enforcement beyond basic safety.

Project Links

Source code, package distribution, releases, and documentation.

Need Implementation Details?

Read the FAQs for usage patterns, integration caveats, and rollout guidance.