Does anybody has a sample of gradle configuration to deploy dokka-generated docs as github pages?

# dokka

[altavir]

Does anybody has a sample of gradle configuration to deploy dokka-generated docs as github pages?

[jaguililla]

I’m doing it with GitHub actions, pushing changes to the gh-pages branch. I’m not pushing the markdown directly, but I use it to generate the final site with MkDocs. If you think you could get what you need from there, you can start checking: https://github.com/hexagonkt/hexagon/blob/master/.github/workflows/release.yml#L53

[altavir]

Thanks, I was wondering if there is a shortcut to just publish docs without additional clutter, but it seems that default way to do so. I found this plugin: https://github.com/marketplace/actions/github-pages-action, but I still need to add and index page before using it.

[jaguililla]

Well... I wanted to give advice, and I received it. That action looks pretty neat, I'll check if I can streamline documentation publishing with it. Thanks!

[altavir]

This is what community is made for. 🙂 I think I will try to use Orchid for site generation when I have time for that.

[elect]

consider also netlify

[altavir]

Netlify is not a static site generator, it is a deployment and administration platform. Orchid supports it.

[elect]

you were interested in a gradle sample deploying dokka docs in GH Pages

[elect]

Netlify fits as an alternative

[altavir]

What does netlify have to do with that? It does not generate the site content by itself. It provides a way for dynamically change site content and re-generate it on-flight. But how does it help with static documentation?

[elect]

you can deploy dokka docs on that instead of Pages, reading around it's much more powerful and features rich

[altavir]

OK, I see now. I am not sure how it helps with the static content, but it is of course an option.

[elect]

it doesnt, I was just suggesting you an alternative to Pages

[corneil]

Have a look at https://github.com/open-jumpco/open-jumpco.github.io for how to publish to githib pages.
https://github.com/open-jumpco/kfsm