search

asciidoctor / docs.asciidoctor.org

The Antora playbook project (i.e., site manifest) for the Asciidoctor documentation site.
https://docs.asciidoctor.org
MIT License
14 stars 18 forks source link

add asciidoctor-epub3 documentation #60

Closed slonopotamus closed 3 years ago

slonopotamus commented 3 years ago

Accompanying PR: https://github.com/asciidoctor/asciidoctor-epub3/pull/391

mojavelinux commented 3 years ago

If you want to see a deploy preview, you'll need to change the git reference to point to the PR branch until it is merged into the master branch.

slonopotamus commented 3 years ago

I tried making a preview from my PR branch and it looks OK: https://deploy-preview-60--asciidoctor-docs.netlify.app/epub3-converter/latest/ Do you want me to adjust EPUB3 position in left-hand component list? I see that you have some custom order, however fail to infer the logic behind it.

slonopotamus commented 3 years ago

Note to myself: after this gets merged I also need to open a PR to uncomment https://github.com/asciidoctor/asciidoctor-docs-ui/blob/fa9c28ad6c1a6d3612e42b0162fccdb49419c2e2/src/partials/header-content.hbs#L51

slonopotamus commented 3 years ago

I switched this PR back to asciidoctor-epub3 main branch, so this can be merged as soon as asciidoctor/asciidoctor-epub3#391 is merged.

mojavelinux commented 3 years ago

Do you want me to adjust EPUB3 position in left-hand component list?

Yes, please list it in the comma separated list after reveal.js-converter.

however fail to infer the logic behind it.

The * represents all components not otherwise listed in alphabetical order. Aside from that, it's just a regular comma-separated list.

slonopotamus commented 3 years ago

Yes, please list it in the comma separated list after reveal.js-converter.

Done.

The * represents all components not otherwise listed in alphabetical order. Aside from that, it's just a regular comma-separated list.

I mean, I didn't get the logic behind the exact manual order of components. You said that epub3 goes between reveal.js and diagram-extension, but it still isn't clear why it is the right place for epub3 :) I'm just placing it there because you said so.

mojavelinux commented 3 years ago

I mean, I didn't get the logic behind the exact manual order of components.

Ahhh. Sorry to have misunderstood you.

I don't think there's a perfect order and it may need refinement. I'm roughly trying to list them in the order someone might need to use them, with the language and core processors up top and the extensions at the bottom. The converters should be grouped, and their order based on the number of downloads (a rough sense of popularity). Asciidoclet is near the Maven Tools since it is often used together in the same build.

slonopotamus commented 3 years ago

order based on the number of downloads

OK, that makes sense.

So... It seems like everything in this PR and asciidoctor/asciidoctor-epub3#391 is good enough, so maybe you could push the buttons in both of them?

mojavelinux commented 3 years ago

Sure thing.

mojavelinux commented 3 years ago

It's live. See https://docs.asciidoctor.org/epub3-converter/latest/

I've also added it to the config for the search scraper so it will show up in search results.