3 ms·
I wish more people wrote docs in this fashion. I almost always end up skipping official docs in favor of digging around for blog posts going over code examples
by bilalq 5y ago
I wish more people wrote docs in this fashion. I almost always end up skipping official docs in favor of digging around for blog posts going over code examples on things.
- samhw 5y agoIt's not unheard of. A few examples come to mind: - Go By Example: https://gobyexample.com/ https://gobyexample.com/ - Rust By Example: https://doc.rust-lang.org/rust-by-example/ https://doc.rust-lang.org/rust-by-example/ - V [a weird knockoff of Go] By Example: https://v-community.gitbook.io/v-by-example/ https://v-community.gitbook.io/v-by-example/ There's also 'Learn X in Y Minutes' (https://learnxinyminutes.com/ https://learnxinyminutes.com/), which covers a range of different 'X'es. They make it ridiculously easy to get going with a new tool/language, IMO. It's a superb paradigm in general.
- suyash 5y agoI loved the simplicity and directness of the UI too. Specially like the feature where mouse cursor maps to code blocks, how did you create this ? I'd like to use this framework if possible for tech blogs.
- macintoshpie 5y agoThanks! The page itself is just simple HTML and tables. I generated it from YAML files with a custom HTML generator, see for example: https://github.com/macintoshpie/ghactionsbyexample/blob/df6ff876a9ce246cfedb86f8b17a8d3461f1bf18/examples/hello-world/hello-world.yml#L1 https://github.com/macintoshpie/ghactionsbyexample/blob/df6f...