Ability to download Themes for Asciidoctor PDF

[fwilhe]

Hello,

we're using a theme for Asciidoctor PDF for our corporate style. Because we don't want to copy the style in each repository that contains documentation, I began to write a plugin which extends the asciidoctor-gradle-plugin. More background is in this issue: asciidoctor/asciidoctor-pdf#420

I don't mind keeping this in a separate plugin, but it occurred to me, that this functionality might actually be useful as part of this plugin.

What do you think about that? Please keep in mind that my current code is just a proof of concept, and if I were to make a PR for this project out of it, I would definitely refactor properly.

[fwilhe]

For those who are interested, my plugin is published now: https://plugins.gradle.org/plugin/com.github.fwilhe.asciidoctor-pdf-theme

Issues and Pull Requests are welcome :)

[ysb33r]

Should document this for 2.0 and maybe even create a compatibility test

[ysb33r]

The first work on this has has been done and should be ready for 2.0-alpha.3 (#251) . An extension called pdfThemes will be added by the org.asciidoctor.jvm.pdf plugin.

The extension can then be used to register local or remote themes.

pdfThemes {
    local 'basic1', { 
        styleDir = file('themes/basic') 
        styleName = 'very-basic' 
    }

    github 'basic2', { 
        organisation = 'fwilhe' 
        repository = 'corporate-theme' 
        relativePath = 'resources/themes' 
        branch = 'master' 
    }

    gitlab 'basic3', { 
        organisation = 'fwilhe' 
        repository = 'corporate-theme' 
        relativePath = 'resources/themes' 
        branch = 'master' 
    }
}

To use the theme just tell the task about the theme

asciidoctorPdf {
  theme 'basic3'
}

[fwilhe]

Thanks a lot for your work on this, @ysb33r.

I like the github/gitlab special handle, but I wonder how this would work for private hosted instances of github enterprise or gitlab. Is there an option to provide a plain git url, or would I clone that manually and add it as local?

Very much looking forward to this release 👍

[ysb33r]

It is possible to use `baseUri='http://` to set another base uri. (That is how it is tested off-line) I have not given thought yet to providing credentials.

…

Sent from my Samsung device

-------- Original message -------- From: Florian Wilhelm <[email protected]> Date: 29/07/2018 17:17 (GMT+01:00) To: asciidoctor/asciidoctor-gradle-plugin <[email protected]> Cc: "Schalk W. Cronjé" <[email protected]>, Mention <[email protected]> Subject: Re: [asciidoctor/asciidoctor-gradle-plugin] Ability to download Themes for Asciidoctor PDF (#186) Thanks a lot for your work on this, @ysb33r. I like the github/gitlab special handle, but I wonder how this would work for private hosted instances of github enterprise or gitlab. Is there an option to provide a plain git url, or would I clone that manually and add it as local? Very much looking forward to this release 👍 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread. {"api_version":"1.0","publisher":{"api_key":"05dde50f1d1a384dd78767c55493e4bb","name":"GitHub"},"entity":{"external_key":"github/asciidoctor/asciidoctor-gradle-plugin","title":"asciidoctor/asciidoctor-gradle-plugin","subtitle":"GitHub repository","main_image_url":"https://assets-cdn.github.com/images/email/message_cards/header.png","avatar_image_url":"https://assets-cdn.github.com/images/email/message_cards/avatar.png","action":{"name":"Open in GitHub","url":"https://github.com/asciidoctor/asciidoctor-gradle-plugin"}},"updates":{"snippets":[{"icon":"PERSON","message":"@fwilhe in #186: Thanks a lot for your work on this, @ysb33r.\r\n\r\nI like the `github`/`gitlab` special handle, but I wonder how this would work for private hosted instances of github enterprise or gitlab. Is there an option to provide a plain git url, or would I clone that manually and add it as `local`?\r\n\r\nVery much looking forward to this release 👍 "}],"action":{"name":"View Issue","url":"#186 (comment)"}}} [ { "@context": "http://schema.org", "@type": "EmailMessage", "potentialAction": { "@type": "ViewAction", "target": "#186 (comment)", "url": "#186 (comment)", "name": "View Issue" }, "description": "View this Issue on GitHub", "publisher": { "@type": "Organization", "name": "GitHub", "url": "https://github.com" } }, { "@type": "MessageCard", "@context": "http://schema.org/extensions", "hideOriginalBody": "false", "originator": "AF6C5A86-E920-430C-9C59-A73278B5EFEB", "title": "Re: [asciidoctor/asciidoctor-gradle-plugin] Ability to download Themes for Asciidoctor PDF (#186)", "sections": [ { "text": "", "activityTitle": "**Florian Wilhelm**", "activityImage": "https://assets-cdn.github.com/images/email/message_cards/avatar.png", "activitySubtitle": "@fwilhe", "facts": [ ] } ], "potentialAction": [ { "name": "Add a comment", "@type": "ActionCard", "inputs": [ { "isMultiLine": true, "@type": "TextInput", "id": "IssueComment", "isRequired": false } ], "actions": [ { "name": "Comment", "@type": "HttpPOST", "target": "https://api.github.com", "body": "{\n\"commandName\": \"IssueComment\",\n\"repositoryFullName\": \"asciidoctor/asciidoctor-gradle-plugin\",\n\"issueId\": 186,\n\"IssueComment\": \"{{IssueComment.value}}\"\n}" } ] }, { "name": "Close issue", "@type": "HttpPOST", "target": "https://api.github.com", "body": "{\n\"commandName\": \"IssueClose\",\n\"repositoryFullName\": \"asciidoctor/asciidoctor-gradle-plugin\",\n\"issueId\": 186\n}" }, { "targets": [ { "os": "default", "uri": "#186 (comment)" } ], "@type": "OpenUri", "name": "View on GitHub" }, { "name": "Unsubscribe", "@type": "HttpPOST", "target": "https://api.github.com", "body": "{\n\"commandName\": \"MuteNotification\",\n\"threadId\": 138117944\n}" } ], "themeColor": "26292E" } ]

[ysb33r]

In final release of 2.0 (Scheduled for last week in March).