Scorpio turns textual specifications into diagrams.
Screenshots and examples at scorpio diagrams
This repo illustrates how to use GitHub to store marked up images for display as Scorpio diagrams (gitwrapping). It also has the JavaScript code.
- ./images/ - subdirectory has png images which become annotated
- ./diagrams/ - contains the specs for the annotations
- ./wiki/ - is for the documents the diagrams are embedded in.
See ./docs/Usage.md for more details of how to use.
There is no build step.
The text and diagrams are all rendered client side using JavaScript.
Scorpio diagrams software in this repo is licensed with the MIT license. The documentation in this repo, in the ./docs/ subdirectory is under the MIT license too.
The examples in this repo in the subdirectories ./images/, ./diagrams/ and ./wiki/ are MIT licensed or more permissively. My intention is that all actual images in ./images/ will be public domain. See ./images/rights.md
This repo includes in ./katex/ a copy of a version of the LaTeX to html renderer, KaTeX. That is MIT licensed too. See their repo for more details of their module.
KaTeX fonts which are part of KaTeX are SIL Licensed:
"This Font Software is licensed under the SIL Open Font License, Version 1.1. This license available with a FAQ at: http://scripts.sil.org/OFL"
See KaTeX/KaTeX#339