Hyper-literate programming is to literate programming exactly what hypertext documents are to regular books and texts.

Go to file

Georges Dupéron 741a761476 Quick documentation & passable LaTeX support		2017-05-16 00:26:48 +02:00
comments	Attempt at typing hide-#%comment, it looks horrible.	2017-01-13 00:56:08 +01:00
lang	Allow the last expresion of the lang-line to span multiple lines. Stop providing #%top-interaction, so that one from the user's language is used instead (still can't access the bindings without providing them + (require (submod .)), but it's a step forward)	2017-05-11 23:38:46 +02:00
private	Added support for highlighting parts of literate programs.	2017-05-15 21:38:49 +02:00
scribblings	Quick documentation & passable LaTeX support	2017-05-16 00:26:48 +02:00
test	Attempt at typing hide-#%comment, it looks horrible.	2017-01-13 00:56:08 +01:00
.gitignore	Initial commit	2016-06-16 14:21:44 +02:00
.travis.yml	Build with fewer CPUS, to avoid OOM	2017-01-12 22:17:02 +01:00
comment-reader.rkt	Note: maybe we should use the 'scribble property instead of 'first-comments and 'comments-after	2017-02-01 07:56:13 +01:00
diff1.rkt	Quick documentation & passable LaTeX support	2017-05-16 00:26:48 +02:00
info.rkt	Quick documentation & passable LaTeX support	2017-05-16 00:26:48 +02:00
lang.rkt	Allow the last expresion of the lang-line to span multiple lines. Stop providing #%top-interaction, so that one from the user's language is used instead (still can't access the bindings without providing them + (require (submod .)), but it's a step forward)	2017-05-11 23:38:46 +02:00
LICENSE.txt	Initial commit	2016-06-16 14:21:44 +02:00
main.rkt	Cleaned up the definition of @chunk and @CHUNK. Fixed issues with subscript numbers on chunks, links, and conflicting tags. Now it's possible to re-print a chunk several times without problem.	2016-09-20 03:12:58 +02:00
README.md	Added Installation section to README	2016-08-17 15:09:48 +02:00
restore-comments.rkt	Cleaned up hiding/restoring comments, partially typed	2017-01-10 15:54:34 +01:00

README.md

hyper-literate

Some tools which help build hyper-literate programs.

Hyper-literate programming is to literate programming exactly what hypertext documents are to regular books and texts. Literate programming is about telling other programmers how the program works (instead of just telling the compiler what it does). Telling this story can be done using non-linear, hyperlinked documents.

For now these utilities only help with manipulating LP chunks (e.g. repeating the same chunk in several places in the output document, but keeping a single copy in the source code).

Ultimately, the reading experience should be closer to viewing an interactive presentation, focusing on the parts of the program that are of interest to you: expand on-screen the chunks you are curious about, run some tests and see their result, etc.

Imagine something like code bubbles, but with explanatory text coming along with the source code.
Imagine something like Inform, but focused on exploring a program instead of exploring an imaginary world — after all, a program is some kind of imaginary world.

Installation

Install with:

raco pkg install --deps search-auto hyper-literate