Pubblica documentazione
come un sito reale
Pubblica VitePress, Docusaurus, Nextra, VuePress, MkDocs e altre build di documentazione statica con HTML ottimizzato per la ricerca, domini personalizzati, HTTPS e percorsi di rilascio prevedibili.
Formati di documentazione che vediamo ogni giorno
Dove l'hosting della documentazione diventa complicato
Il sito diventa troppo grande per lo strumento
Gli strumenti per i documenti ospitati sono convenienti, ma i team spesso incontrano limiti relativi al branding, alle pagine personalizzate e al controllo che hanno sul sito finale.
I wiki di base sono troppo limitati
Una wiki va bene per le note. I documenti dei prodotti pubblici di solito necessitano di ricerca, navigazione leggibile, domini personalizzati, metadati e una prima impressione più pulita.
L'hosting autonomo richiede tempo tecnico
La gestione dei server, SSL, la pubblicazione degli hook e l'igiene del rilascio non dovrebbero competere con la scrittura dei documenti.
Controlla build prima di pubblicare
Carica la cartella generata
Docusaurus di solito produce build, VitePress usa .vitepress/dist e MkDocs scrive in site. Carica i file generati, non il Markdown sorgente.
Conferma i percorsi di base
Se la documentazione vive in un sottopercorso o in un percorso di progetto, assicurati che il base URL del framework corrisponda all'URL finale.
Prova la ricerca e la navigazione
Apri una build di produzione localmente e controlla gli indici di ricerca, i link della barra laterale, i percorsi delle versioni e i deep link prima di condividere l'URL pubblico.
Mantieni gli asset cache-friendly
I siti di documentazione spesso servono molte piccole immagini, font e file JavaScript. Una pubblicazione statica permette di memorizzare facilmente gli asset nella cache di rete.
Costruito per più di un tipo di documentazione
Documenti di progetto open source
Pubblica guide, log delle modifiche e documenti sulla migrazione su un dominio brandizzato senza trasformare il sito dei documenti in un progetto operativo separato.
Riferimenti API
Fornisci siti di riferimento puliti con ricerca, navigazione e layout di codifica più facili da scansionare rispetto a un BLOB generato.
Basi di conoscenza interne
Ospita manuali di progettazione, runbook e documentazione di processo con una struttura del sito pulita.
Documentazione del prodotto
Pubblica documenti di onboarding, guide di configurazione e riferimenti alle funzionalità che rimangono veloci per i clienti in ogni regione.
Sistemi di progettazione
Esponi l'utilizzo dei componenti, i token e i modelli in un sito navigabile che può crescere con il prodotto.
Funziona con i principali stack di documenti statici
Domande frequenti sull'hosting della documentazione
Posso pubblicare l'output di VitePress o Docusaurus qui?
Sì. Esegui prima la build del framework, poi carica la directory di output statico generata. DeployPages serve HTML, CSS, JavaScript e asset finali.
Come funzionano i domini personalizzati per i siti di documenti?
Aggiungi il dominio dopo la pubblicazione, indirizza il record DNS alla destinazione fornita e DeployPages effettua il provisioning di HTTPS automaticamente.
Posso ospitare anche documentazione privata?
La soluzione più efficace oggi è la documentazione pubblica e i documenti di prodotto aperti. Il controllo degli accessi è in espansione, ma il flusso principale resta la pubblicazione statica.
Questo aiuta con SEO?
Può. HTML statico, URL pulito, metadati utili e consegna rapida forniscono alla documentazione una base tecnica più solida per la visibilità della ricerca.
Pubblica la build della documentazione come sito
Carica la cartella della documentazione generata e offri ai lettori un luogo veloce e personalizzato in cui trovare le risposte.
Supporta HTML, CSS, JS e i tipici asset della documentazione statica.