I just tagged the first release of pandoc-scdoc.
The goal is what it sounds like, write SuperCollider help files in Markdown, org-mode, or rst and convert them directly into valid .schelp files.
The long-term goal is to make this suitable for upstream inclusion in pandoc. For now, it remains a standalone tool while the mapping is tested against real-world usage.
Repo: https://github.com/smoge/pandoc-scdoc
0.1.0.0 is still experimental, but already covers the main pieces:
- markdown, rst, and org-mode
- SCDoc metadata
- Standard help sections:
Description,ClassMethods,InstanceMethods,Examples - methods and arguments inferred from document structure, or tagged with pandoc attributes
- tables, notes, warnings, links, anchors, code etc
- raw scdoc passthrough
Examples: pandoc-scdoc/examples at main · smoge/pandoc-scdoc · GitHub
I’d appreciate feedback from people who write or maintain sc help files. Where the mapping feels natural, where it gets in the way, and what would be better fit.
If you have a file that would make a good test case, I’d be glad to include in the test. I’m genuinely curious to hear what breaks.