olofson / audiality2

A realtime scripted modular audio engine for video games and musical applications.
http://audiality.org/
zlib License
79 stars 5 forks source link

Use Markdeep for documentation? #344

Closed olofson closed 6 years ago

olofson commented 6 years ago

How does Markdeep integrate with GitHub? It would be nice to have graphs and diagrams and whatnot in the documentation, without relying on external tools.

http://casual-effects.com/markdeep/

olofson commented 6 years ago

Played around a bit with Markdeep here, but since it's effectively HTML, which cannot be previewed in GitHub, I'm not sure how useful it is... Documents need to be downloaded or put on a web site, so they can be watched directly in a browser.

olofson commented 6 years ago

There is a way to get this to work (relatively) smoothly with GitHub: GitHub Pages. Initial "port" coming up in a moment...