- Write custom checks in Ruby (+ Danger) https://krausefx.com/blog/writing-automated-tests-for-your-documentation
- Best looking documentation (Django) https://docs.djangoproject.com/en/2.0/topics/http/urls/
- Pandoc, Gumroad, https://thorstenball.com/blog/2018/09/04/the-tools-i-use-to-write-books/
- Serial book writers. They have a tool to inline code as part of code fence. Process is brilliant https://www.fullstack.io/write-a-book/ tool: https://github.com/fullstackio/cq/blob/master/packages/cq/doc/readme/README.cq.md
Note for my future self:
- The easiest thing to do is to stick to md. It’s easy to use, you can use any program to view it and can easily be processed.
- However, markdown is too simple. If you want to augment md, use the same technique of r markdown. Use code snippets to include code and write a md -> to -> md converter. Or just render to text directly.
- MDX is not portable or easy to use. R markdown works with python only.
- You might be tempted to include snippets of code dynamically like in https://github.com/fullstackio/cq . Don’t. It’s not portable. Instead think about md files as jest snapshot testing. They are prerendered and on disk. If the state is stale, let CI tell you. A project on a similar mindset is https://github.com/DavidWells/markdown-magic
- Vue has an excellent mechanism include HTML, JS and CSS https://vuejs.org/v2/guide/single-file-components.html
Running material locally
- https://towardsdatascience.com/interactive-go-programming-with-jupyter-93fbf089aff1
- https://github.com/Originate/text-runner
- https://github.com/mdx-js/mdx
- https://github.com/nbedos/termtosvg
- https://news.ycombinator.com/item?id=17440770
- https://news.ycombinator.com/item?id=17399340
- Learning platform:
- https://github.com/Paqmind
- https://paqmind.com/tutorials/async-programming/callbacks/
- https://github.com/faressoft/terminalizer
- https://twitter.com/jessfraz/status/1027396437582196736
- https://news.ycombinator.com/item?id=17781569
- https://thorstenball.com/blog/2018/09/04/the-tools-i-use-to-write-books/
- https://intoli.com/blog/terminal-recorders/