radareorg / radare2-book

The Official Radare2 Book
https://book.rada.re
Creative Commons Attribution Share Alike 4.0 International
797 stars 227 forks source link

Convert book into "literate radare" #76

Open XVilka opened 6 years ago

XVilka commented 6 years ago

There is a concept of literate programming, and running the code from the documentation. We should make a scripts/change the book to do exactly the same. So what we need:

XVilka commented 6 years ago

Like rustdoc does: https://doc.rust-lang.org/beta/rustdoc/documentation-tests.html

radare commented 6 years ago

👍

On 15 Nov 2017, at 02:04, Anton Kochkov notifications@github.com wrote:

Like rustdoc does: https://doc.rust-lang.org/beta/rustdoc/documentation-tests.html

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

XVilka commented 6 years ago

After it is done - we may be even can add the checks into the radare2 PR/master to check every commit automatically.

XVilka commented 6 years ago

Or this https://github.com/realworldocaml/mdx

XVilka commented 4 years ago

Started a PoC here: https://gist.github.com/XVilka/12faa18643e66a184699aa717d8f6f2e

Maijin commented 4 years ago

👍 I made a POC too of this looooong time ago