Come produrre un parco giochi di documentazione (mescolando codice html e swift)?

Question

Qualcuno ha trovato un modo carino per creare un documento simile a GuidedTour.playground con un mix di sezioni html e codice rapido senza doverlo fare manualmente?

possiamo esplorare il contenuto del file parco giochi che è un pacchetto e si vede un file xml contents.xcplayground html/file veloci e descrivere la struttura ma sarebbe bello essere in grado di creare uno in un user-friendly modo.

Answer 1

A partire dalla versione 6.3 questa funzione è ora parte di Xcode.

Citazione dalla nota di rilascio:

Migliorata l'authoring di documentazione con linea commenti marcati-up, risultati parco giochi in linea, la possibilità di visualizzare e modificare le risorse incorporate nei campi da gioco, e la capacità di integrare i file sorgente ausiliaria in campi da gioco. Queste funzionalità consentono la creazione di nuove e ricche esperienze nei parchi giochi.

Answer 2

Sono sicuro che non esiste un flusso di lavoro automatizzato (almeno non pubblico) disponibile per ora. Ma perché non crearne di propri se ne hai davvero bisogno?

• È possibile utilizzare il grande strumento di workflow automation-Grunt (http://gruntjs.com) che è molto spesso utilizzato nel web-industria.
• È possibile scrivere il proprio piccolo script/app (perché non in modo rapido: D) per analizzare il proprio file doc personalizzato (con una sintassi predefinita per contrassegnare le sezioni di codice e documentazione).

Entrambi i modi di cucitura sono fattibili per me, ma la domanda è ovviamente se ne vale la pena.

Answer 3

Aprire la cartella del parco giochi in Sublime o un IDE. È necessario modificare il file di estensione .xcplayground all'interno di tale cartella .playground in modo tale da inserire tag documentation immediatamente prima o dopo il tag swift code.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<playground version='3.0' sdk='macosx'> 
    <sections> 
     <code source-file-name='section-1.swift' hidden="true" /> 
     <documentation relative-path='fragment0.html'/> 
     <code source-file-name='section-3.swift'/> 
     <documentation relative-path='fragment11.html'/> 
     <code source-file-name='section-5.swift'/> 
     <documentation relative-path='fragment21.html'/> 
     <code source-file-name='section-7.swift'/> 
     <documentation relative-path='fragment22.html'/> 
     <code source-file-name='section-9.swift'/> 
     <documentation relative-path='fragment23.html'/> 
     <code source-file-name='section-11.swift'/> 
     <documentation relative-path='fragment24.html'/> 
     <code source-file-name='section-13.swift'/> 
     <documentation relative-path='fragment25.html'/> 
     <code source-file-name='section-15.swift'/> 
     <documentation relative-path='fragment26.html'/> 
     <code source-file-name='section-17.swift'/> 
     <documentation relative-path='fragment27.html'/> 
     <code source-file-name='section-19.swift'/> 
     <documentation relative-path='fragment31.html'/> 
     <code source-file-name='section-21.swift'/> 
     <documentation relative-path='fragment32.html'/> 
     <code source-file-name='section-23.swift'/> 
     <documentation relative-path='fragment33.html'/> 
    </sections> 
    <timeline fileName='timeline.xctimeline'/> 
</playground> 

La documentazione e il file Swift e struttura delle cartelle devono essere come questo.

Answer 4

Anche se la risposta attualmente contrassegnato come 'corretta' può essere stato vero, al momento della scrittura, ci sono infatti diversi modi per farlo.

• Markdown: Jason Sandmeyer swift-playground-builder è disponibile su GitHub a https://github.com/jas/swift-playground-builder e può essere installato con npm install -g swift-playground-builder. Come pure avere una riga di comando può anche essere richiamato a livello di codice da JavaScript e quindi chiamato da Gulp (richiede Node.JS e NPM)
• Asciidoc: James Carlson ad2play è disponibile su GitHub a https://github.com/jxxcarlson/ad2play e può essere eseguito come Scriipt rubino (richiede Ruby e asciidoctor installati)