Как создать площадку для документации (смешивая HTML и Swift-код)?

Question

Кто-нибудь нашел хороший способ создать документ, похожий на GuidedTour.playground, с сочетанием HTML-разделов и быстрого кода без необходимости делать это вручную?

Мы можем изучить содержимое файла игровой площадки, который представляет собой пакет, и он показывает файлы html/swift и XML-файлcontent.xcplayground, описывающий структуру, но было бы неплохо иметь возможность создать его удобным для пользователя способом.

Answer 1

нашей версии 6.3 Эта функция теперь является частью XCode.

Цитата из выпуска Примечание:

Улучшенная документация, авторская авторская документация с встроенным отмеченным комментариями, встроенные игровые площадки, возможностью просмотра и редактирования ресурсов, встроенных в детские площадки, а также возможность интегрировать вспомогательные исходные файлы на детские площадки.Эти функции позволяют создавать богатые новые впечатления на игровых площадках.

Answer 2

Хотя ответ, помеченный в настоящее время как «правильный», возможно, был верным на момент написания, на самом деле существует несколько способов сделать это.

• Уценка:Джейсон Сэндмейер swift-playground-builder доступен на GitHub по адресу https://github.com/jas/swift-playground-builder и может быть установлен с помощью npm install -g swift-playground-builder.Помимо наличия командной строки, его также можно вызывать программно из JavaScript и, следовательно, вызывать из Gulp (требуется Node.JS и NPM).
• Аскиидок:Джеймс Карлсон ad2play доступен на GitHub по адресу https://github.com/jxxcarlson/ad2play и может быть запущен как скрипт Ruby (требуется установленный Ruby и asciidoctor)

Answer 3

Откройте папку игровой площадки в Sublime или IDE.Вам необходимо отредактировать файл расширения .xcplayground в этой папке .playground, куда вы вставляете documentation тег прямо до или после 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>

Документация и структура файлов и папок Swift должны быть такими.

Answer 4

Я почти уверен, что на данный момент нет автоматического рабочего процесса (по крайней мере, нет публичного).Но почему не создавать свои собственные, если вам это действительно нужно?

.
• Вы можете использовать Great инструмент для рабочего процесса - Grunt ( http://gruntjs.com ) который довольно часто используется в веб-индустрии.
• Вы можете написать свой собственный маленький скрипт / приложение (почему не в самом SWIFT: D), чтобы разбирать пользовательский документ DOC-файл (с предопределенным синтаксисом, чтобы пометить разделами кода и документации).

Обе пути, которые для меня выполнимо, но вопрос конечно, если оно того стоит.