51–54 of 54 posts
Earlier quoted context omitted.
This sounds a lot like the R Markdown format. https://rmarkdown.rstudio.com/articles_intro.html
I understand that R Markdown format is not similar to the GitHub MarkDown format. (Correct me if I am mistaken.) I would like to use the basis format of GitHub, also because it compatible with the github.io documentation websites.
Earlier quoted context omitted.
I found Mr. Ross' funnelweb utility to have the best syntax. Unique and easy to read. http://ross.net/funnelweb/tutorial/index.html Unfortunately the only known implementation was last updated over two decades ago, and is written in pretty hard to understand C. I asked for permission and started a repository here: https://github.com/loa-in-/fw-utf8 I currently have it unmodified there, except for disabled check for A…
It's unfortunate that Funnelweb itself wasn't written in a literate style!
I still use it from time to time, especially for small, well defined projects, because I find it useful to have to argue with myself when designing a software. It's not so much about producing a nice documentation or a proper exposition of some idea, than it is about having to formulate all the reasoning, the alternatives, and the choices.
[0]: https://github.com/rixed/portia [1]: http://rixed.github.io/portia/
Earlier quoted context omitted.
It's unfortunate that Funnelweb itself wasn't written in a literate style!
For the record, I wrote portia[0], based on funnelweb and which accept a (mostly) compatible syntax, in a literate style. Its source/doc can be browsed [1]. I still use it from time to time, especially for small, well defined projects, because I find it useful to have to argue with myself when designing a software. It's not so much about producing a nice documentation or a proper exposition of some idea, than it is a…
Earlier quoted context omitted.
Thanks for your comment. Are you aware of a literate programming tool that primarily uses tags in source files to link with documentation in txt files? I guess I am thinking one could tangle the source with docs to produce the documentation, while the source is passed to the compiler unchanged.
There's a variation called "elucidative programming" [1] wherein the source is marked with "anchors" that the documentation can reference. Since source code lives in traditional source files, all the regular development infrastructure continues to work. When the source/documentation bundle is processed, the output is a two-pane coordinated view of code and discussion. [1] http://people.cs.aau.dk/~normark/elucidative-…