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

Build system: mdBook and Makefile #304

Open
ratijas opened this issue Dec 28, 2020 · 2 comments
Open

Build system: mdBook and Makefile #304

ratijas opened this issue Dec 28, 2020 · 2 comments

Comments

@ratijas
Copy link
Contributor

ratijas commented Dec 28, 2020

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
Copy link
Contributor Author

ratijas commented Dec 28, 2020

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

@trufae
Copy link
Contributor

trufae commented Jun 1, 2021

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

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

No branches or pull requests

2 participants