#rust #mdBook
Does anyone know if there is a relatively simple way to make a renderer for mdBook that could access and modify the generated HTML output of the default HTML renderer before it is written to the HTML files? Or do I need to fork the existing HTML renderer? Because it does not exactly look like a simple task…
Creating a website on GitHub pages with mdBook
https://youtube.com/watch?v=x3vF9YiWBMQ
#github #mdbook #website
Does anyone have a tool they prefer for #writing printable #books, committing it in #git, and rendering it as static html site (or maybe just good navigation in #codeberg itself), and also rendering a nice #pdf with table of contents, footers, indices, etc.? Something like #mdbook, #bookdown, #pandoc, or the like? I'm flexible with the exact syntax of the docs. I'm using mdbook with mdbook-pdf at the moment. I haven't tried mdbook-latex yet. (Using something like jinja would be nice.)
Finally had some time to play around with #mdbook. And I must say, I am impressed.
Very easy to use, very intuitive. And the documentation is really excellent (and written as a mdbook...).
https://github.com/rust-lang/mdBook
https://rust-lang.github.io/mdBook/index.html
mdbook makes it really easy to put together some markdown files and create a good looking, browsable documentation.
After trying to use #mdbook for in-project #documentation, I decided that I'm using it wrong.
I want the docs to be readable both from git browsers and generated HTML. mdbook does that by converting ".md" to ".html" in links.
But then, I have a couple of .md files that should be linked but don't need to be in the index, like "COPYING.md". I don't think mdbook can do that.
I have to modify selected links (to source documentation), and it's a miss here too.
mdbook is really for books.
I was asked on Reddit how `mdbook-i18n-helpers` work. In short, the project gives you two `mdbook` plugins: one for extracting text from the original Markdown files and one for injecting the translations back into the original Markdown.
See https://www.reddit.com/r/rust/comments/12by6u7/comment/llzsmpc/ for much more detail :-)
Does anyone know if https://github.com/lzanini/mdbook-katex can be used to render equations in Rust doc strings? Like, I get that I can used it in book.toml in an mdbook, but can I use it in a rust crate somehow?
Thanks to @kdarkhan, we have a new release of mdbook-i18n-helpers: https://github.com/google/mdbook-i18n-helpers/releases/tag/mdbook-i18n-helpers-0.3.3
This release fixes bugs in the handling of inline HTML in your #Markdown and it adds support for #Gettext translation comments.
Thanks to amazing work by Max Heller, you can now download all five #Rust courses in Comprehensive Rust as a 375-page PDF! They're generated using #pandoc from the #mdbook sources. You'll find them for every translation too:
- English: https://google.github.io/comprehensive-rust/comprehensive-rust.pdf
- Korean: https://google.github.io/comprehensive-rust/ko/comprehensive-rust.pdf
- Spanish: https://google.github.io/comprehensive-rust/es/comprehensive-rust.pdf
etc. See https://github.com/google/comprehensive-rust/pull/1572 for the tooling Max wrote.
With #mdbook, any ideas how to:
New Video!
Make a Book for Free with mdBook, A static site generator written in Rust :)
Thanks to #mdbook, I'm well on my way to finally completing my private #wiki / #docs for all things #tech: home network, desktop, mobile, code snippets and so on, guides I'm sure I'll be glad I can easily reference again someday.
I started my wiki some time ago, but only recently got the momentum back to make real progress with it. It's a good feeling. #documentation.
https://rust-lang.github.io/mdBook/