radare2-book icon indicating copy to clipboard operation
radare2-book copied to clipboard

Build system: mdBook and Makefile

Open ratijas opened this issue 4 years ago • 2 comments

Describe the issue

Makefile is trash, npm modules fail not install, gitbook-cli (from package.json) is unmaintained/abandoned.

Currently this project uses GitHub actions exclusively, which in turn uses rust-lang/mdBook. So it shouldn't be an issue for deploying.

But local testing is broken; instructions are missing.

How to reproduce?

git clone && make

Expected behavior

Rendered book.

Possible fix

Provide alternative script and/or instructions to render the book locally.

AFAICT, installing cargo install mdbook should be just about enough of a setup. Alternatively, there's a docker image at peaceiris/mdbook.

Screenshots

None

Additional context

Is this project abandoned? -- GitbookIO/gitbook-cli

ratijas avatar Dec 28 '20 23:12 ratijas

Yep, running mdBook from the root of the book directory works.

ratijas avatar Dec 28 '20 23:12 ratijas

I have added support for pandoc to generate pdf and epub, latest builds are in the release page. CI is still not ready and there's lot of unsync doc to be updated and reviewed. So just one little step forward to get that in shape

trufae avatar Jun 01 '21 09:06 trufae