This is the homepage of “Literate Programming” – a WordPress plugin. Latest releases and development log is hosted by WordPress.org. Feature requests and ideas for improvements are always welcomed.

Motivation

Literate Programming For WordPress - Increase Source Code Understanding and Quality

The Internet is full of open source code, especially on posting platforms like WordPress – sharing ideas, techniques, methods and finally implementations is crucial for development. One major drawback of “just” posting the source code: post reader has to work through published code on their own, in most cases. As soon as the post author wants to explain some code snippets, these sections most likely have to be rewritten again, thus introducing unnecessary cross-referencing. A post might become more complex than needed.
I recently read a book about Physically Based Rendering by M. Pharr who constantly used the concept of literate programming to introduce a somewhat complex software design. From my personal experience: the introduction was much easier to understand than traditional introductions to software systems. For my last post on Wavefront OBJ Loader, I needed a way to gradually introduce the reader of this post to the proposed loader implementation. It was very important to discuss important sections, I didn’t wanted to repeated code snippets throughout the post. In addition, I searched and couldn’t find any suitable WordPress for this task. The reason for introducing literate programming to WordPress.

Using the Plugin

This section will be filled up in no time. In the meantime, I refer to “introducing literate programming to WordPress” and hosted plugin site.