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

mdbook without installation possible? #46

Closed
rufus42 opened this issue Nov 16, 2022 · 4 comments
Closed

mdbook without installation possible? #46

rufus42 opened this issue Nov 16, 2022 · 4 comments

Comments

@rufus42
Copy link

rufus42 commented Nov 16, 2022

Hello Tom Milligan @tommilligan,

thank you very much for your great work.

Is there any way to use the exe file without mdbook-admonish install?
I can`t / am not allowed to install anything on my computer.

Thanks for your time and sorry for asking my question here, I didn`t find any forum or similar unfortunately.

Many greetings
rufus42

@schungx
Copy link
Contributor

schungx commented Nov 17, 2022

It appears that mdbook will spawn separate processes to run pre-processors... can you save a pre-built binary in your local folder, point your PATH to it, and then try?

If you can't even save files into your own folders, then how can you build the book?

@tommilligan
Copy link
Owner

Hi, thanks for your question. There are a couple of points that I think are being confused here:

  • You can install the mdbook-admonish binary in a location that you control (i.e. doesn't require admin privileges). Here, "installation" is just saving a file in a specific location.
    • For example, mkdir ./tmp && cargo install mdbook-admonish --root ./tmp will compile mdbook-admonish and save it to ./tmp/bin/mdbook-admonish
    • You could also just download the precompiled binary, available from the Github releases page
  • mdbook-admonish install simply updates your mdbook's book.toml. Here, installation refer's to "installing" the configuration required for mdbook-admonish into your existing configuration.
  • If you need to save the mdbook-admonish binary in a non-standard location (as above), to make your config work you will probably need to do one of:
    • In book.toml, change command = "mdbook-admonish" to command = "./path/to/tmp/bin/mdbook-admonish"
    • Update your $PATH to include the binary's location

I hope these steps are helpful for you - if you still have problems, please let me know:

  • Specifically what step you are having problems with
  • Any relevant commands you have run, and their output
  • Your operating system and version of rust/mdbook/mdbook-admonish

@rufus42
Copy link
Author

rufus42 commented Nov 17, 2022

Hello Tom Milligan @tommilligan ,

many, many thanks for your response.
I was totally touched/excited by your detailed, beginner-friendly answer.

IT WORKS!

My point of misunderstanding:
I thought I had to have Rust installed to run mdbook-admonish install.
I guess I didn`t read carefully enough.
(English is not my mother tongue, my native language is German. I have my posts translated by DeepL.)

Thanks for your clear words, your plugin helps me.
And most of all: thanks for your work!

Many greetings
rufus42

Problem: solved

Translated with www.DeepL.com/Translator (free version)

@tommilligan
Copy link
Owner

Excellent, glad it's working for you! No problem at all, happy to help.

Closed as resolved.

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

3 participants