mdBook

Book is what this site layout is called in the community, see also: Rust Book: https://doc.rust-lang.org/book Rust Rand Book: https://rust-random.github.io/book Rust WebAssembly Book: https://rustwasm.github.io/book Rust Unstable Book: https://doc.rust-lang.org/beta/unstable-book/index.html Rustonomicon: https://doc.rust-lang.org/beta/nomicon/index.html Cargo Book: https://doc.rust-lang.org/cargo Which seems to be generated by https://github.com/rust-lang/mdBook Now, I don't see why "book" should seem so grand. Remember when reference books would come out as a "bible"? As for bounds check, here's a relevant issue raised on rand crate: https://github.com/rust-random/rand/issues/592 One can dig for a kind of "unsafe assertions" with https://doc.rust-lang.org/std/hint/fn.unreachable_unchecked.... (so the random code, for example, could have

MdBook: https://github.com/rust-lang/mdBook

mdBook! https://github.com/rust-lang/mdBook It can do LaTeX and code, and be updated in real time so those were real time notes! Some other examples * https://briantliao.com/interviewing-notes/ * https://briantliao.com/deep-learning-notes/ * https://briantliao.com/guitar-notes/

Thanks, probably this issue? https://github.com/rust-lang/mdBook/issues/1304

I'm using mdBook [0] and haven't changed the default theme settings. Could you clarify that by 'code element' you mean the code blocks or inline code? I think you mean inline code for 'Coal' and 'Navy' themes, because for other combinations I'm able to see them properly. [0] https://github.com/rust-lang/mdBook

I'm building a similar resource for Python[1]. To make it easier to browse and provide search functionality, I'm using mdBook[2]. I'd suggest you to check out mdBook or a static-site generator like Zola[3] to convert md-to-html and host it via GitHub pages or your own domain. [1] https://learnbyexample.github.io/py_resources/ [2] https://github.com/rust-lang/mdBook [3] https://www.getzola.org/documentation/getting-started/overvi...

Recently played with https://github.com/rust-lang/mdBook as well and was very impressed.

I'm personally a huge fan of `mdbook`, which seems to be the Rust equivalent of R's `bookdown`. I've switched out internal documentation over to it from `gitbook`. https://github.com/rust-lang/mdBook

mdBook [1] is an option if you want to convert markdown to a static website. There's plenty of customization options but I don't know if it is possible or easy enough to add comments. Or just publish it on GitHub? There's a discussions feature but I don't think it is out of beta yet. Until then you could use issues for discussions. Or reddit may be? [1] https://github.com/rust-lang/mdBook

Thanks for posting clickable links and feedback about the markdown sources. I use pandoc to convert markdown to pdf/epub and my initial learning with pandoc [1] resulted in single file usage. So, I kept it like that. I'm planning to create a separate chapter-wise branch so that I can publish a nicer web version with tools like mdBook [2]. This will require a bit of scripting to handle references across chapters. [1] https://learnbyexample.github.io/tutorial/ebook-generation/c... [2] https://github.com/rust-lang/mdBook

See also mdBook [0] for another alternative to Gitbook [0] https://github.com/rust-lang/mdBook

I feel like using a straight bloom filter will get you some false positives and may not be a right fit, but it is an interesting take & might be good for a first-pass. mdbook (https://github.com/rust-lang/mdBook) uses elasticlunr (http://elasticlunr.com/) as an inverted index and is generated statically. The same is done for zola (https://www.getzola.org/documentation/content/search/).

I felt the same way so have switched completely to taking nodes using https://github.com/rust-lang/mdBook I back everything up in a private git repo and then use various plugins built on top of mdbook to get all the functionality I want: * rendering graphviz: https://github.com/dylanowen/mdbook-graphviz * adding tags to the pages: https://github.com/dylanowen/mdbook-tag * setting up sections to only render locally and not get published: https://github.com/dylanowen/mdbook-access The plugin system is super easy to use and you don't need to code everything in rust. You can use any language. I'm also working on a better renderer instead of just running the mdbook server all the time: https://github.com/dylanowen/mdnotes I believe with plugins you can meet most of the requirements you have: * bidirectional: definitely could be a plugin * math

This is amazing. Curious how you search or go back to refer them? Have you considered porting this to a doc generator like mdBook(https://github.com/rust-lang/mdBook).