Powiedzmy, że chciałbym zacząć pisać tutoriale. W formie tekstu. Z osadzonymi snippetami kodu w JS. Z możliwością odpalania tych snippetów. Czy są jakieś narzędzia, które mogłyby mi to ułatwić?
Przy czym chciałbym mieć workflow taki, że piszę normalnie apkę - np. jeśli uczę, jak zrobić grę w węża, to faktycznie robię tę grę w węża i na podstawie tego kodu jest generowany tutorial. Mogłoby to być rozwiązane przez jakieś adnotacje w komentarzach. Albo odwrotnie - być może cały projekt bym pisał np. w Markdown osadzając bloki kodu i same by się generowały pliki z kodem (chociaż myślę, że to gorszy pomysł).
W każdym razie zależy mi na poszanowanie zasady DRY. To, czego chcę uniknąć, to zrobienie apki, a później ręcznie wycinanie z niej kawałków kodu.
No i zależy mi, żeby to rozwiązanie było open source i kompilowało się do statycznych plików HTML/CSS/JS. No i żeby można było łatwo osiągnąć minimalistyczny design, bez rozmaitych śmieci. No i żeby to było proste w użyciu i rozszerzaniu.
Ktoś coś wie?
W sumie nie wiem pod czym szukać. tutorial software w Google pokazuje jakieś apki do tworzenia tutoriali video.
A może jakiś tool do tworzenia dokumentacji? Tylko nie chodzi mi właśnie o komentowanie "per funkcja", tylko o możliwość tworzenia własnych snippetów np. na takiej zasadzie:
// @snippet loop
for (let i = 0; i < 100; i++) {
// @endsnippet
}
a potem osadzanie tego np. tak:
Tak możemy napisać pętlę:
{{ snippet('loop') }}
ew. może jakiś tool do literate programming?
Pewnie skończę się tym, że sam napiszę jakiś własny tool, ale jestem ciekaw, czy ktoś już czegoś takiego nie wymyślił.