Giters

heckj / swiftui-notes

content for Using Combine - notes on learning Combine with UIKit and SwiftUI

Home Page:https://heckj.github.io/swiftui-notes/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

How to export and generate docset format？

iT-Boyer opened this issue · comments

commented

Describe the solution you'd like
A clear and concise description of what you want to see added or updated.

Because of the instability of the network, I want to generate a docset file to use in dash App, so I can quickly preview relevant content locally.

commented

I'm sorry, but the content is nowhere near the format that would be needed for a DocSet. It was hand created and curated, based loosely on the documentation that (at the time) Apple provided.

That said, if you manually create the elements for the DocSet format, I imagine you could assemble what you're after, using the HTML that's already rendered. Kapeli has their details at https://kapeli.com/docsets#dashDocset.

That transformation isn't something that I'll be doing though.

commented

I'm going to manually create the elements for the DocSet format, but there are errors when using the docker method to generate HTML format files。

$ cd swiftui-notes
$ docker run --rm -v $(pwd):/documents/ --name asciidoc-to-html heckj/docker-asciidoctor asciidoctor -v -t -D /documents/output -r ./docs/lib/google-analytics-docinfoprocessor.rb docs/using-combine-book.adoc

this log:

asciidoctor: WARNING: coreconcepts.adoc: line 299: no callout found for <1>
asciidoctor: WARNING: coreconcepts.adoc: line 300: no callout found for <2>
asciidoctor: WARNING: coreconcepts.adoc: line 301: no callout found for <3>
asciidoctor: WARNING: coreconcepts.adoc: line 302: no callout found for <4>
asciidoctor: WARNING: coreconcepts.adoc: line 304: no callout found for <5>
asciidoctor: WARNING: coreconcepts.adoc: line 305: no callout found for <6>
Input file: docs/using-combine-book.adoc
  Time to read and parse source: 0.72550
  Time to convert document: 0.46890
  Total time (read, parse and convert): 1.19440
commented

Good news is that those are warnings, not errors - so everything rendered out as you see in the HTML page, regardless of those notes. Those are due to the content in coreconcepts.adoc from line 297 to 307. I'm using the callout mechanisms to make a list of callouts even though the associated diagram (in SVG format) doesn't have any code references for those callouts. I'm slightly mis-using the callout structure there in order to provide a visual display of the lifecycle of a combine pipeline.

commented

thanks , i find the output dir in swiftui-notes。