Private Dokumentation
Schütze deine Docs-Seite mit einem Passwort im Pro-Plan oder lass im Enterprise-Plan nur die Personen rein, die du auswählst.
Aktualisiert am 19. Nov. 20263 Min. Lesezeit
Mache deine Docs-Seite privat, damit nur Personen mit dem Passwort sie lesen können. Verwende das für interne Dokumentation, Partnerportale oder Dokumentation zu einem Produkt, das noch nicht gestartet ist. Ein Passwort gibt es im Pro- und Enterprise-Plan, und nur die Personen einzulassen, die du auswählst, ist im Enterprise-Plan möglich. Beides richtet sich nach dem Plan des Projektinhabers.
Seite privat machen
- Gehe zu Settings > Who can read.
- Wähle People with the password.
- Gib ein Passwort mit mindestens 8 Zeichen ein und klicke auf Protect with password.
Deine Seite fragt sofort nach dem Passwort, auf deiner eigenen Domain und auf your-project.typemark.dev sowie bei ihren Vorschauen.
Das Passwort wird von Typemark gespeichert, nicht in deinem Repository oder in typemark.json. Es landet daher nie auf GitHub, und ein Push kann deine Seite nicht öffentlich machen.
Was Leser sehen
Leser sehen eine Seite mit dem Namen, dem Logo und den Farben deiner Seite sowie ein Passwortfeld. Sobald sie das Passwort eingeben, bleiben sie 30 Tage lang in diesem Browser angemeldet.
Sie melden sich pro Adresse einmal an. Eine Anmeldung auf deiner eigenen Domain meldet sie nicht auch auf your-project.typemark.dev an.
Alle geben das Passwort ein, auch die Mitglieder deines Projekts.
Was privat bleibt
Für alles auf der Seite wird das Passwort benötigt:
- Seiten und deren Markdown-Versionen
- Suche und KI-Suche
llms.txtundllms-full.txt- Bilder und andere Dateien aus deinem Repository
- Feedback „War diese Seite hilfreich?“
Nur dein Logo und dein Favicon werden ohne Passwort geladen, damit die Passwortseite sie anzeigen kann.
Eine private Seite:
- weist Suchmaschinen an, sie nicht zu indexieren, und wird in keiner Sitemap aufgeführt
- hat keinen MCP-Server, und ihre Seiten zeigen kein Seitenaktionsmenü und keine Karte „Diese Dokumentation mit KI verwenden“, da sich KI-Tools nicht anmelden können
- wird nie von einem Browser- oder Proxy-Cache gespeichert
Nur ausgewählte Personen einlassen
Im Enterprise-Plan kannst du auf das gemeinsame Passwort verzichten und Personen anhand ihrer Identität einlassen. Wähle unter Who can read die Option People you choose.
- E-Mail-Domains: Alle mit einer E-Mail-Adresse bei diesen Domains, etwa
partner.io, können lesen. Sie geben ihre geschäftliche E-Mail-Adresse ein, und wir schicken ihnen einen Anmeldelink. Der Link funktioniert einmal und 15 Minuten lang. - Single Sign-on zulassen: Personen auf deinen Single-Sign-on-Domains melden sich über deinen Identity Provider an, statt auf eine E-Mail warten zu müssen. Diese Option erscheint, sobald SSO eingerichtet und aktiviert ist.
Leser bleiben wie beim Passwort 30 Tage lang angemeldet. Das Ändern der Domains oder der SSO-Einstellung meldet alle ab.
Die Anmeldeseite antwortet gleich, unabhängig davon, ob eine E-Mail-Adresse lesen darf, sodass sie Fremden nie verrät, wer Zugriff hat. Wir senden höchstens fünf Links pro Stunde an dieselbe Adresse.
Das Lesen der Dokumentation über SSO meldet niemanden bei Typemark selbst an. Leser benötigen kein Typemark-Konto.
Passwort ändern
Gib unter Who can read ein neues Passwort ein und klicke auf Change password. Alle, die sich mit dem alten Passwort angemeldet haben, müssen sich erneut anmelden.
Seite wieder öffentlich machen
Wähle Anyone und klicke auf Make public. Typemark vergisst dann das Passwort, daher braucht es beim späteren erneuten Privatmachen ein neues.
Wenn du Pro oder Enterprise verlässt
Typemark macht deine Seite niemals automatisch öffentlich. Du kannst sie jederzeit in jedem Plan öffentlich machen.
- Eine passwortgeschützte Seite bleibt privat und behält ihr Passwort. Zum Ändern des Passworts benötigst du wieder Pro oder Enterprise.
- Eine Seite für ausgewählte Personen bleibt auf diese beschränkt, und die Anmeldelinks per E-Mail funktionieren weiterhin. Die Anmeldung über dein Single Sign-on endet, da SSO im Enterprise-Plan enthalten ist. Im Pro-Plan kannst du die Seite stattdessen auf ein Passwort umstellen.