Vai al contenuto

Banco di prova per contenuti condivisi

Questa sezione è inclusa allo scopo di verificare il contenuto condiviso fornito da questo repository per l'uso nel resto della documentazione BeeWare. Per "contenuto condiviso" si intendono documenti o sezioni di documenti comuni a più repository. Essi sono memorizzati qui per essere inclusi in tutti i repository. Ciò significa che esiste un'unica fonte quando sono necessari aggiornamenti e che le modifiche saranno applicate a tutti i repository che utilizzano quel contenuto condiviso.

Se stai aggiornando contenuti esistenti, i seguenti passaggi non sono necessari. Puoi semplicemente creare il sito di prova e vedere i tuoi aggiornamenti visualizzati.

Se stai creando un nuovo file di documentazione condiviso nella directory shared-content, che NON deve essere incluso nella directory how-to, procedi come segue:

  1. Crea un file nella cartella content_test_bed con lo stesso nome del tuo nuovo file di contenuto, aggiungendo "_include" alla fine.
    • Per style_guide.md, dovresti aggiungere style_guide_include.md.
  2. Utilizzando la sintassi Snippets, aggiungi il nome del file a filename_include.md. La sintassi Snippets per includere contenuti è -8<- "filename.md".
    • Per style_guide.md, dovresti aggiungere -8<- "style_guide.md" a style_guide_include.md.
  3. Aggiorna la sezione Shared content test bed in /docs/SUMMARY.md per includere il nuovo file _include e il percorso, allo stesso livello di indentazione degli altri elementi in quella sezione.
    • Per style_guide_include.md, dovresti aggiungere - [Style guide](content_test_bed/style_guide_include.md).

Una volta completati questi passaggi, è possibile creare il sito di prova e visualizzare la nuova documentazione renderizzata.