Publiceer documentatie
als een echte website
Publiceer VitePress, Docusaurus, Nextra, VuePress, MkDocs en andere statische documentatiebuilds met zoekvriendelijke HTML, eigen domeinen, HTTPS en voorspelbare releasepaden.
Documentatieformaten die we dagelijks tegenkomen
Waar het hosten van documentatie rommelig wordt
De website ontgroeit de tool
Hulpmiddelen voor gehoste documenten zijn handig, maar teams lopen vaak tegen grenzen aan als het gaat om branding, aangepaste pagina's en hoeveel controle ze hebben over de uiteindelijke website.
Basiswiki's zijn te beperkt
Een wiki is prima voor aantekeningen. Openbare productdocumenten hebben meestal zoekmogelijkheden, leesbare navigatie, eigen domeinen, metadata en een schonere eerste indruk nodig.
Zelfhosting kost technische tijd
Het beheren van servers, SSL, deploy hooks en releasehygiëne mag niet concurreren met het schrijven van de documenten.
Controleer de build voordat u publiceert
Upload de gegenereerde map
Docusaurus schrijft meestal naar build, VitePress gebruikt .vitepress/dist en MkDocs schrijft naar site. Upload de gegenereerde bestanden, niet de Markdown-bron.
Bevestig basispaden
Als de documenten onder een subpad of projectroute staan, zorg er dan voor dat de base-URL van het framework overeenkomt met de uiteindelijke URL.
Test zoeken en navigeren
Open lokaal een productie-build en controleer zoekindexen, zijbalklinks, versiepaden en deep links voordat u de openbare URL deelt.
Houd assets cachebaar
Documentatiewebsites leveren vaak veel kleine afbeeldingen, lettertypen en JavaScript-bestanden. Door statisch te publiceren kunnen assets gemakkelijk via het wereldwijde netwerk worden gecachet.
Gebouwd voor meer dan één soort documentatie
Open-source projectdocumentatie
Publiceer handleidingen, changelogs en migratiedocumenten op een merkdomein zonder van de documentenwebsite een afzonderlijk operationeel project te maken.
API-referenties
Lever overzichtelijke referentiewebsites met zoek-, navigatie- en codevriendelijke lay-outs die gemakkelijker te scannen zijn dan een gegenereerde blob.
Interne kennisbanken
Host technische handboeken, runbooks en procesdocumentatie met een overzichtelijke websitestructuur.
Productdocumentatie
Publiceer introductiedocumenten, installatiehandleidingen en functiereferenties die snel beschikbaar zijn voor klanten in elke regio.
Design systems
Maak het gebruik van componenten, tokens en patronen zichtbaar op een navigeerbare website die met het product kan meegroeien.
Werkt met de belangrijkste statische documentatiestacks
Veelgestelde vragen over documentatiehosting
Kan ik hier VitePress- of Docusaurus-uitvoer publiceren?
Ja. Voer eerst de frameworkbuild uit en upload vervolgens de gegenereerde statische uitvoermap. DeployPages bedient de uiteindelijke HTML, CSS, JavaScript en assets.
Hoe werken eigen domeinen voor documentenwebsites?
Voeg het domein toe na de publicatie, wijs het DNS-record naar het opgegeven doel en DeployPages richt HTTPS automatisch in.
Kan ik ook privédocumentatie hosten?
De sterkste match vandaag zijn openbare documentatie en open productdocumenten. Toegangscontrole breidt zich uit, maar de kernflow van vandaag is statisch publiceren.
Helpt dit met SEO?
Het kan. Statische HTML, schone URLs, nuttige metadata en snelle levering geven documentatie een sterkere technische basis voor zoekzichtbaarheid.
Publiceer de documentatiebuild als een website
Upload de gegenereerde documentatiemap en geef lezers een snelle, gemerkte plek om antwoorden te vinden.
Ondersteunt HTML, CSS, JS en typische statische documentatie-assets.