2 ms·

I'd like to see literate programming melded with the docs as code approach. A simple way to see (say) myfile.go and myfile.md displayed side-by-side, with comme

I'd like to see literate programming melded with the docs as code approach. A simple way to see (say) myfile.go and myfile.md displayed side-by-side, with comments and their code targets aligned side-by-side during scrolling. (Or, alternatively, comments & code interleaved... but then when the comments and code are both collapsible, it's not much different from current IDEs.) This shouldn't be too awfully difficult. Process myfile.go to autogenerate myfile.md, which contains markers or tags or labels to indicate the points to align with the course code. Is this making any sense ?

jhidding 3y ago
Yes it does. We (at the Netherlands eScience Center) will be building such an interface next January, extending Entangled (https://entangled.github.io https://entangled.github.io). This approach uses Markdown and enables editing your code both in Markdown and generated source codes, synchronizing when files are written to. Currently with traditional documentation site generators like MkDocs, you can get nicely presented content, but what you suggest requires a bit more work. We will build better content navigation in Pandoc, and a side-by-side view as you suggest is definitely on the table. Also: outside contributions are more than welcome ;)
- euroderf 3y ago
  It does look nifty. Altho getting up to speed is non-trivial. I don't suppose you have any working examples in the Go language ?
  - jhidding 3y ago
    Sadly nothing Go specific. We're working on making it easier to work with.
    - euroderf 3y ago
      Go already has built-in support for tests and for executable examples (that go into generated package documentation), so it might get hairy.