Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a release with ebooks on push to master #837

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

siddhpant
Copy link

@siddhpant siddhpant commented Aug 24, 2023

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

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.
@mudongliang
Copy link
Collaborator

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

@wendajiang
Copy link

wendajiang commented Sep 13, 2023

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/

@siddhpant
Copy link
Author

siddhpant commented Sep 13, 2023

@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.

@wendajiang
Copy link

@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.

@siddhpant
Copy link
Author

siddhpant commented Sep 13, 2023

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!

@mudongliang mudongliang requested a review from 0xAX May 5, 2024 09:33
@mudongliang
Copy link
Collaborator

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

@mudongliang
Copy link
Collaborator

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

@siddhpant
Copy link
Author

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.

@mudongliang
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants