llms.txt beheren in GitHub Pages

By /

llms.txt toevoegen en beheren op een statische site zoals GitHub Pages kan verrassend onduidelijk lijken: waar moet het bestand staan, hoe zorg je dat het correct wordt geserveerd en hoe automatiseer je updates? Op llmstxt.nl helpen we organisaties dit snel en robuust in te richten zodat crawlers en gebruikers altijd de juiste informatie vinden.

In dit artikel leggen we stap voor stap uit hoe je llms.txt op GitHub Pages plaatst, welke valkuilen je tegenkomt en welke checks je direct kunt uitvoeren. Praktische voorbeelden en commando’s maken het meteen toepasbaar.

Locatie en bereikbaarheid van llms.txt

Het llms.txt-bestand moet op een goed bereikbare URL staan, bijvoorbeeld /llms.txt of /.well-known/llms.txt. Beide locaties worden gebruikt in de praktijk; /.well-known is een nette, gestandaardiseerde plek, /llms.txt is simpel en werkt ook prima.

Op GitHub Pages betekent dit dat het bestand in de public root van je site moet staan. Dat kan in de repository root of in de /docs-map, afhankelijk van hoe je Pages publiceert.

Praktische tip of verdieping

  • Maak een bestand genaamd llms.txt of een map .well-known met daarin llms.txt in je Pages-branch (bijv. main of gh-pages).
  • Als je een map .well-known gebruikt, voeg eventueel een lege .nojekyll toe aan de root om Jekyll-verwerking uit te schakelen en verborgen mappen zeker te laten serveren.
  • Wil je een custom domain? Plaats dan hetzelfde bestand in de branch die voor die domeininstelling wordt gepubliceerd.

Best practices voor inhoud en metadata

llms.txt is een plain text-bestand met eenvoudige sleutel-waarde regels. Houd het overzichtelijk: basisvelden zoals naam van het model, versie, licentie en contactinformatie volstaan vaak. Voeg alleen toe wat zinvol en controleerbaar is.

Documenteer wijzigingen via commits: dat maakt het beheer auditbaar en zorgt dat je altijd kunt terug naar een vorige versie als er iets mis gaat.

Praktische tip of verdieping

  1. Maak een korte sjabloon voor llms.txt (voorbeeldregels hieronder) en voeg deze toe aan je repo zodat teams consistente informatie publiceren: 
    name: Voorbeeld-Model
version: 1.2.0
license: CC-BY-4.0
contact: security@example.com
source: https://github.com/organisatie/model
last_update: 2025-09-01
  2. Gebruik duidelijke datumformaten (YYYY-MM-DD) en een contactadres voor vragen of rapportages.
  3. Overweeg velden voor training-data-kenmerken of beperkingen als die relevant zijn voor gebruikers en compliance.

Deployen en automatiseren op GitHub Pages

Handmatig bestanden toevoegen is prima voor één keer, maar voor productieve omgevingen raden we automatisering aan. GitHub Actions kan het bestand vanuit een centrale bron (bijv. een config-repo) naar je Pages-repo pushen bij een release.

Automatisering voorkomt menselijke fouten en zorgt dat llms.txt altijd synchroon loopt met je modelreleases en changelogs.

Praktische tip of verdieping

  • Voorbeeldstappen met GitHub Actions:
    1. Maak een workflow die draait bij een tag of push naar main.
    2. Laat de workflow een sjabloon llms.txt vullen met releasegegevens (bijv. via een small script of action).
    3. Commit en push het gegenereerde llms.txt naar de branch die door GitHub Pages wordt gepubliceerd.
  • Voeg in je workflow een test toe die controleert of de URL bereikbaar is (bv. met curl --fail).
  • Gebruik branch-protecties en review-vereisten om ongewenste aanpassingen te voorkomen.

Valideren en monitoren

Na publicatie wil je zeker weten dat het bestand correct en snel bereikbaar is. Een korte check met curl of een URL-monitoringdienst volstaat meestal om problemen snel te detecteren.

Automatische tests in je CI/CD-pipeline kunnen bovendien controleren op basisvelden en eenvoudige formatfouten.

Praktische tip of verdieping

  • Snelle handcheck met curl: 
    curl -I https://jouwdomein.nl/.well-known/llms.txt
curl https://jouwdomein.nl/.well-known/llms.txt

    Controleer dat de status 200 geeft en dat de inhoud overeenkomt met je laatste commit.

  • Voeg een unit-test toe die controleert op verplichte velden zoals name, version en license.
  • Gebruik uptime-monitoring (bijv. Pingdom, Uptime Robot) voor kritieke publicaties zodat je direct wordt gewaarschuwd bij fouten.

Praktische check die je nu direct kunt doen: open je GitHub Pages-repo, voeg (of update) een bestand .well-known/llms.txt met minimaal name, version en contact, push de wijziging en voer daarna curl -I https://jouwdomein.nl/.well-known/llms.txt uit om te verifiëren dat de server een 200-antwoord geeft en de inhoud overeenkomt met je repository. Heeft je site een custom domain, test dan altijd zowel de user.github.io-URL als het custom domein.

Scroll to Top