suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity
Hyper-literate programming is to literate programming exactly what hypertext documents are to regular books and texts.
1,888 Commits 27 Branches 6 Tags 10 MiB
Racket 100%
66551c6901
Go to file
Georges Dupéron 66551c6901 Temporarily disable the "color the nested language in black" feature for hyper-literate, as it gives incorrect coloring and indentation on large files (I guess the parser is not always called from the start of the file)
2016-12-27 19:10:49 +01:00
lang Temporarily disable the "color the nested language in black" feature for hyper-literate, as it gives incorrect coloring and indentation on large files (I guess the parser is not always called from the start of the file) 2016-12-27 19:10:49 +01:00
private Temporarily disable the "color the nested language in black" feature for hyper-literate, as it gives incorrect coloring and indentation on large files (I guess the parser is not always called from the start of the file) 2016-12-27 19:10:49 +01:00
scribblings Fixed potential conflicts with the injected (require lang). 2016-12-16 16:40:01 +01:00
test Fixed bad bug when a #:save-as chunk contained a ... 2016-09-19 03:12:01 +02:00
.gitignore Initial commit 2016-06-16 14:21:44 +02:00
.travis.yml Don't build on older versions, as we now need a very recent patch 2016-12-16 17:19:57 +01:00
info.rkt Fixed potential conflicts with the injected (require lang). 2016-12-16 16:40:01 +01:00
lang.rkt Added #%top-interaction (not the right one, though) 2016-06-23 21:42:57 +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

README.md

Build Status, Coverage Status, Build Stats, Online Documentation.

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