mdbook
Commands
An nginx server for SSL termination which has a public address of 192.168.1.100 on port 80 and proxied that to 127.0.0.1 on port 8000, should run:
mdbook serve path/to/book -p 8000 -i 127.0.0.1 -a 192.168.1.100 -w 3000
-o --open : mdbook will open the book in your your default web browser after starting the server
-w : 192.168.1.100:<WS_PORT> will be proxied for live reload
deploy on github
remove book/ from .gitignore and commit. On every change to src, run these commands:
mdbook test
mdbook serve
git add .
git commit -m 'change desc'
git subtree push --prefix book origin gh-pages
Features
- syntax highlighting
- annotated
rustcode
# fn main() { let x = 5; let y = 6; println!("{}", x + y); # }
- editable
fn main() { let number = 5; print!("{}", number); }
- can use runnable rust file via playpen
Additional links
https://michael-f-bryan.github.io/cheat-sheets/