linux-insides icon indicating copy to clipboard operation
linux-insides copied to clipboard

Create a release with ebooks on push to master

Open siddhpant opened this issue 1 year ago • 9 comments

Use GitHub actions to create a release with PDF, EPUB, and MOBI files automatically on push to master. The action can also be triggered manually.

The commit ID will be used as tag for releases.

This action does not use GitBook, but a fork of it named HonKit. gitbook-cli isn't maintained since 6 years, whereas honkit is a maintained fork.

Demo run: https://github.com/siddhpant/linux-insides/actions/runs/5965984941/job/16184642998 Demo release: https://github.com/siddhpant/linux-insides/releases

siddhpant avatar Aug 24 '23 15:08 siddhpant

@0xAX this seems an interesting feature: Github action is useful to do such things, but I am not familiar with its syntax and semantic.

mudongliang avatar Sep 01 '23 12:09 mudongliang

Any progress at this thread? And as gitbook is deprecated, I think mdbook is one alternative tool to auto sync the online doc with github action. I can support it if maintainer pleasure.

Fork repo: https://github.com/wendajiang/linux-insides/ Online demo: https://wendajiang.github.io/linux-insides/

wendajiang avatar Sep 13 '23 02:09 wendajiang

@wendajiang it's the gitbook cli which is deprecated. Gitbook moved everything to its own closed source online platform, which has auto sync with repo.

Though yes, an open-source solution like mdbook or honkit would be nice IMHO. Does mdbook support generation of ebooks (ideally without much overhead and changes)? Asking because only one system should be used to generate both website and ebooks.

siddhpant avatar Sep 13 '23 05:09 siddhpant

@wendajiang it's the gitbook cli which is deprecated. Gitbook moved everything to its own closed source online platform, which has auto sync with repo.

Though yes, an open-source solution like mdbook or honkit would be nice IMHO. Does mdbook support generation of ebooks (ideally without much overhead and changes)? Asking because only one system should be used to generate both website and ebooks.

Sure, mdbook has some unofficial plugin to generate epub or pdf file. I'm not familiar with node ecology, sorry for the mistake.

wendajiang avatar Sep 13 '23 06:09 wendajiang

Sure, mdbook has some unofficial plugin to generate epub or pdf file.

Nice. Let's wait for maintainer's input.

I'm not familiar with node ecology, sorry for the mistake.

Dw, neither am I!

siddhpant avatar Sep 13 '23 13:09 siddhpant

I tried Honkit recently, and it works after revising assembly syntax. I prefer to use Honkit.

mudongliang avatar May 05 '24 09:05 mudongliang

And I prefer to revise assembly to x86asm before applying this PR. However, x86asmatt is not applied now.

mudongliang avatar May 05 '24 09:05 mudongliang

And I prefer to revise assembly to x86asm before applying this PR. However, x86asmatt is not applied now.

I agree that would be great, but that will break the instance hosted at the gitbook website.

To avoid that, there should be a complete move from gitbook website to a static website made using honkit on GitHub pages.

This sounds like a bigger task, hence I just used sed before generating the pdf.

siddhpant avatar May 05 '24 10:05 siddhpant

And I prefer to revise assembly to x86asm before applying this PR. However, x86asmatt is not applied now.

I agree that would be great, but that will break the instance hosted at the gitbook website.

👍 Let's finish the infrastructure movement and then change the keyword assembly.

To avoid that, there should be a complete move from gitbook website to a static website made using honkit on GitHub pages.

This sounds like a bigger task, hence I just used sed before generating the pdf.

mudongliang avatar May 05 '24 10:05 mudongliang