Our great sponsors
-
I would recommend using Vale for writing in a text editor. It't a prose linter and can approach grammarly like rules as well as handling spelling for technical documents fairly well.
-
Very cool. I co-edit Peter Shirley's _Ray Tracing in One Weekend_ (https://raytracing.github.io/) and have taken a similar approach, though with a different toolset. At some point if I find the time, I'll write up a similar article on our approach and what we've learned. Our books are open-sourced on GitHub (https://github.com/raytracing/raytracing.github.io), and we also use GitHub to host our books.
Basically, we use Markdeep (https://casual-effects.com/markdeep/), a _very_ powerful Markdown implementation with a bunch of built-in features. The killer feature is that with a handful of boilerplate lines (UTF-8 declaration at the top, and JavaScript loader at the bottom), you get content that automatically self-transforms in the browser into a full HTML document. This eliminates any build step, and means you can treat it as you would any other HTML file, with optional CSS and other features. It also bundles in a LaTeX engine, ASCII diagram rendering, and a whole host of other features. If you look at the three ray tracing books, you can see how simple the source is, and how pleasing the final rendering.
Check out the books and the GitHub repo — it's a _great_ way to quickly and easily pound out a web book.
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
-
build
Source code and build system used to generate the book Hands-on Scala Programming (by handsonscala)
For my book Hands on Scala, I did a totaly different approach: parsed markdown into HTML myself, used puppeteer to turn it into PDFs. The build tool made it easy to import libraries like CommonMark-Java or ApachePDFBox to do what I wanted, wire in external tools like Puppeteer, and gave parallelism and incrementality for free. End result was <1s turnaround on editing chapters and <60s turnaround to regenerate the whope book from scratch
The build pipeline is here, if anyone wants to take a look https://github.com/handsonscala/build