Documentation generator for Snap!data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKAAAAB4CAYAAAB1ovlvAAAK5UlEQVR4Xu2dV6gUPRTHz7X33nvvXWxYUMGKBQQRwQdR3wQVRLGhTypWFB8EUXxUFBTrgy8WVOwNO/bee2/f5z+QZXacnbI7c3OWnAMX9W4yOeU3yUk2iQX//RUSEQ8Y8kCBAGjI89Ks8oAAKCAY9YAAaNT90rgAKAwY9YAAaNT90rgAKAwY9YAAaNT90rgAKAwY9YAAaNT90rgAKAwY9YAAaNT90rgAKAwY9YAAaNT90rgAKAwY9YAAaNT90rgAKAwY9YAAaNT90rgAKAwY9YAAaNT90rgAKAwY9YAAaNT90rgAKAwY9YAAaNT90rgAKAwY9YAAaNT90rgAaAEDf/78IfyElYKCAipatGjY4jmVEwBzch//yh8+fKCzZ89GVrR69erUrl27yPWiVhAAo3osj8o/f/6crl+/Tn369Inco128eJE+ffpEvXv3TtRiATBR95p9+MGDB6lv375UrFixrBQ5cuQIderUiSpUqJBV/TCVBMAwXsrTMgBwwIABhGF4+/bt9P37d/r48WOaNWXKlEkDFPlf06ZNadCgQXT37l369esXNW/ePDEPCICJudb8gwFgv379aMOGDfTt2zfq1auXgtApAOz8+fNUtmzZtN937dqV6tWrp4Bt2bJlYsYIgIm51vyDASB6s3379lGtWrWoSpUqnkr9/PmTrl69qnrCZcuW0Zw5c6h06dI0ePBgAdB8GPNXAwCI4XPPnj3UrVs3+vz5M92+fZuKFy9OlSpVSsvtrly5ogydOnUqzZ8/nypXrkzjx48XAPM3/OY1B4BNmjSh/fv3U+3atRVUFStWVMMwLsYtVaoUvX//nl69ekXPnj0j5H9PnjyhunXrSg9oPnz5r4GehCAH/P37NzVr1kwZhb9DsDj95csXBeGPHz/SDB4+fLjqKSUHzH8OjFmgAQRoGIafPn2qer5Mgs8wGenfvz81bNhQDdcQ5JFJiUxCkvIsg+ceOnSIevTooYbTbOTw4cPUvXv3rOuHaVMADOOlPC2DbzJOnz5NHTt2VJOOIkWKhLIEOSLqoTfs3LlzqDrZFhIAs/VcntT7+vUrnTt3TuV4+FoNEB4/fjyVB3qZgclInTp1qEWLFolbKQAm7mLzDbx48YLu3bunZrc3b96ktm3bUo0aNcwr9lcDAZBFGJJVApMRCHLBnj17JttYxKcLgBEdlm/FX758SZcvX1Zbq7DFipsIgNwiYpk+AqBlAedmrgDILSKW6SMAWhZwbuYKgNwiYpk+AqBlAedmrgDILSKW6SMAWhZwbuYKgNwiYpk+AqBHwBcvXkzYkJn0TpAwrG3cuFGd5xgxYkSY4mllrl27pv7dunXryHULq0LsAOLcAZy2bds2evv2rTqTMHDgQJowYQJVrVq1sOzKuh3oqr879du8mXUDESoeOHCAhgwZompkowt2tWRbN4KaORWNFcC1a9fSjBkzlELY9lOyZEnCdiDIrFmzaPny5TkpWxiVcSBnyZIlLAL38OFDatCgQda6WAUger5y5cqpo316648G5vXr12r/GZctQEEgY8sSemsOPfadO3eUTzWIQbo7P7cKQOy2wNE+HHCJepUDziq8e/dO9Zg4DF2iRAlfPwNw9KwAvn79+lFikkhZ9FTYfQy7secuk+AlRFk9KqA8dqgE2RtWaaQ8ON0GwQ5obCr1G4K13tim1ahRo7DNxFoutiEYJ6hwyh4HWXAUMIzgtD4OvOAooFOmTZtGGM7dghP8OKOAdrTAedhuFLbNTHrp3sL5eaa8y9mz4PDOgwcPUtXQU92/f/+fZjCxWbhw4T/XpOHMxokTJ9LKR9EFFfWJN7yYXuK2Ay98q1at1JUdWpAy7dq1K6vJTphYZ/T7X+UyH5OK8GScvtczNdwpEuaNwh10OLF15swZ5RAcAQRgeDORh82dOzelAXb11qxZU/UYABFv+OPHj1PXRgDKXO60Gz16dKqt3bt3+/YcGhD0YHiJjh49qoZrzJoR1K1bt9K4ceNSzwOQ8Ad0xsQCNuA2AlybduzYMVq3bl2ap6PogooYObDlfvLkybRgwQLl0y1btqi/Q5whBqwY0vFz48YN5VPsGcQIpg+u5/oyR8Am3h3Rbdq0IT31R0+wY8cOwh0jXjJv3jxaunSpGrZRzyleuYuG1f2+IL+sVq2aAhFXkcUhQbmT/hxDp/OuFWdwAZgWpAmPHj1KZCar/bhp0yaaNGlSoB+R4uDFxXlg52k5rTt6Qn1uOA5fBj0jtiFYN4QljLFjxxLAgOBk1d69e9VZ0yDI9OdeAOB3ONn/5s2bf2wKAibICe7Pg56nP/fqdb3qzpw5k1avXq16efTeuJEgrITVxWsgy+RHd6/o5/ewemZbLnYAtSLIRzCUXLp0Sf1q4sSJtHnz5pSe2jleszudUzmdivJ4Y722lXuVz9YhqBd30PFMXImhcy7kvWvWrKFhw4YFpg1x6xLV77n4MUzdxADUjQMOJOrut047wm+VHjc2Od9O5Fl+SznO8mGMz1Qm7qDrdjBMIi/TM1UMd7ixAN+6FJYuUf2eix/D1E0cQCiB5PzChQvqB4ekw/QybuXhuA4dOhCujk1akgJQ643lkhUrVqgc2P1ietntV8ZP16hDcNJ+9Xp+oQCIe+ngdOeQqpdtkNMhtwuSICiC6kf5PKitqEHP1Da+prx165bv5CRbXbp06aLyzUwjT9RVA73Ug9k2ltqi5LF+vo8NQHz/O2rUqLQhEspi2WHkyJH/OAIr/MiFMAxh9uq8BhbLAViYdi7q4mYnGI5EXi97aMNQ3n3DZxTgUNa5hta4cWNVHctJWpzLSlEBxB0t7du3T/tmRc/evXq3KLpguQpfH+LWA/gFoOB6Xf19tvv5+qtGLCEhZXH6GH5EzLw6BCzXYCkMglwcs+g4JDYAnYunenqvV/zxb0z93YZNmTKFkBdpQTksX+iFZvfMDvkf1qy0E/CnbiPX5UyvxV+ng90TIi9w8Du/Yc9Lb0xGpk+fnhbLKLqgIu55hh/wMuv/DwSpik533L7By4DFewjWAzEaBX1njwXzU6dOqTqAFstKcUhsAKJH27lzp7qHRF/rhcXN2bNn+94xgssR169fr66RhaBXHDp0qLpcG2tWbsGQtWjRorQ2MMPGf0WQi+D7Xz9x3pOiy3rdneL1GXTGwjB8g28hIFiqwsIxFqfdEkUXXXfVqlXqInL4fOXKleq5fnpicog6J0+eTPl9zJgx6lre8uXLe7oCHQZ6bsQ5LokNwLgUkufY5QEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7awVAdiGxSyEB0K54s7NWAGQXErsUEgDtijc7a/8H94Mc8wmkqkUAAAAASUVORK5CYII=Documentation generator for Snap!Computes the sum of two numbers.55This block creates new variables on the selected scope: global (for all sprites), sprite (for this sprite only) or script (only for that blocks stack) with the names given (in 'names' list).
If there is already a variable with that name in that scope, it does nothing: no errors and no overwrites.pt:cria as variáveis _ _
ca:crea les _ variables _
es:crear las _ variables _
de:erstellen _ var _
pl:utwórz zmienną _ _
globalglobal
sprite
scriptThis block deletes all the variables with the names given (inside input list).
Each name will make only one variable deletion, and this will be the variable found following the scope order: 'script' -> 'sprite' -> 'global'.
If we have a "testing" sprite variable and also a "testing" global one, deleting "testing" will delete only the sprite one (Yes! we can also do "delete var (testing, testing)" to delete both.
If one variable does not exists (in any scope) an error happens, stopping block action in that point. You can check it before with the "does var (name) exists?"block. pt:remove as variáveis _
ca:esborra les variables _
es:borrar variables _
de:löschen var _
pl:usuń zmienną _
This block sets the given value (last input) to the variable named with the name givent (var input).
It looks for that variable following the scope order 'script' -> 'sprite' -> 'global' (the first match it finds).
If that variable does not exist (in any scope) an error happens, stopping their script. You can check it before using the "does var (name) exists?" block. ca:assigna a _ el valor _
es:asignar a _ el valor _
pt:altera _ para _
de:setze var _ auf _
pl:ustaw zmienną _ na _
§_getVarNamesDictreturns a TOTALLY random number! (XKCD)4Turns a ringified script into a script pic that can be used as a costume.EXCLUDEThis block reports the value of the variable with the name given.
It looks for that variable following the scope order 'script' -> 'sprite' -> 'global' (the first match it finds).
If that variable does not exist (in any scope) an error happens, stopping their script. You can check it before using the "does var (name) exists?" block. pt:o valor de _
pl:zmienna _
§_getVarNamesDictThis block reports "true" if there is a variable with this given name (input slot) in that context.
It can be a global, sprite or script variable.
Otherwise it reports "false".pt:a variável _ existe
ca:existeix la variable _ ?
es:existe la variable _ ?
de:existiert var _ ?
pl:zmienna _ istnieje?
err_resetThis block turns on (show) the watcher view on stage (if it was not already activated) of the variable with the given name (slot input).
It can only access to the closest variable scope (if there different variables with the same name in different scopes) following the order 'script' -> 'sprite' -> 'global'.
No errors if that variable does not exist.ca:mostra la variable _
es:mostrar variable _
pt:mostra a variável _
de:zeige var _
pl:pokaż zmienną _
§_getVarNamesDictThis block turns off (hide) the watcher view on stage (if it was not already activated) of the variable with the given name (slot input).
It can only access to the closest variable scope (if there different variables with the same name in different scopes) following the order 'script' -> 'sprite' -> 'global'.
No errors if that variable does not exist.ca:amaga la variable _
es:esconder variable _
pt:esconde a variável _
de:verstecke var _
pl:ukryj zmienną _
§_getVarNamesDictdata:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAeAAAAFoCAYAAACPNyggAAAOhUlEQVR4Xu3VwQkAAAjEMN1/abewn7jAQRC64wgQIECAAIF3gX1fNEiAAAECBAiMAHsCAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQICLAfIECAAAECgYAAB+gmCRAgQICAAPsBAgQIECAQCAhwgG6SAAECBAgIsB8gQIAAAQKBgAAH6CYJECBAgIAA+wECBAgQIBAICHCAbpIAAQIECAiwHyBAgAABAoGAAAfoJgkQIECAgAD7AQIECBAgEAgIcIBukgABAgQIHLFxAWmhEwHPAAAAAElFTkSuQmCCallBlockscategoriesStagevalueStagedocsblock namedescriptionNo description avaiable.paramsreturnexamplesuuidcategorytypecommandreporterpredicatehatvalueglobal__doc__blockNULLzipnameblockfmtzip.file("assets/" + name + "." + fmt, block.expression.fullImage()
.toDataURL("image/" + fmt).split(',')[1], { base64: true });uuidimgFmtexampleexamples__doc__itemreportercommandpredicatehatcategoriescategory2tagBlock...categoryzipdocsoptionsfunction snapDictionary(list) {
return Object.fromEntries(list.asArray().map((item) => item.asArray()));
}
docs = docs.asArray().map((item) => snapDictionary(item.at(2)));
options = snapDictionary(options);
zip.file("style.css",
`/* THIS FILE WAS GENERATED BY SNAP!DOC */
/* Main CSS file for documentation */
* {
font-family: sans-serif; /* Go with sans serif, its similar to Snap! */
}`);
let blocks = zip.folder("blocks");
let indexHtml =
`<!-- THIS FILE WAS GENERATED BY SNAP!DOC -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="generator" content="Snap!Doc 1.0">
<title>Documentation</title>
<link href="style.css" rel="stylesheet" />
</head>
<body>
<h1>Documentation</h1>
`;
docs.forEach((doc) => {
let html =
`<!-- THIS FILE WAS GENERATED BY SNAP!DOC -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="generator" content="Snap!Doc 1.0">
<title>Documentation for \`${doc["block name"]}\`</title>
<link href="../style.css" rel="stylesheet" />
</head>
<body>
<a href="../index.html"><- Back to home</a>
<h1>Documentation for <img src="../assets/${doc.uuid}.${options.imgFmt}" /></h1>
`;
function tag(name) {
html += `<img src="../assets/tags/${name}.${options.imgFmt}" alt="tag ${name}" />\n`;
}
tag(doc.type);
tag(`category-${doc.category}`);
html += marked.parse(doc.description);
if (doc.params.length() > 0) {
html +=
`<h1>Parameters</h1>
<ul>
`;
doc.params.asArray().forEach((param) => {
html +=
`<li><strong>${param.at(1)}</strong> - ${marked.parseInline(param.at(2))}</li>
`;
});
html += "</ul>\n";
}
if (doc.examples.length() > 0) {
html +=
`<h1>Examples</h1>
<ul>
`;
doc.examples.asArray().forEach((example) => {
html +=
`<li>
${marked.parse(example.at(1))}
<img src="../assets/${example.at(2)}.${options.imgFmt}" />
</li>
`;
});
html += "</ul>\n";
}
if (doc.return != "") {
html += `
<h1>Return value</h1>
${marked.parse(doc.return)}`;
}
blocks.file(doc.uuid + ".html", html + `
</body>
</html>`);
indexHtml += `<a href="blocks/` + doc.uuid + ".html" + `">` +
doc["block name"] + "</a>\n<br>\n";
});
indexHtml += `
</body>
</html>`;
zip.file("index.html", indexHtml);
zip.generateAsync({type:"blob"})
.then(function (blob) {
saveAs(blob, "doc.zip");
});pngYou can also use the following blocks to use a JSON format for options, which allows you to save JSON with your libraries. To copy JSON, simply rightclick the output balloon and select "copy".Steps:
* Load your blocks into this project (drag the XML file in, eventually ill add auto-importing), and add documentation. You might want to, if you're going to make multiple bersion of that library, keep a copy with the documentation blocks, and simply add the new blocks or such that project, and then import the blocks from that project.
* Enable JS
* Fill out options
* Run the code and wait!
Options:
* categories - List of category names to include in the documentation. Can include Snap! categories, not just custom blocks.
* image format - Image format for blocks and examples. Couild be any type supported by your browser, just be warned its best to use image formats that SUPPORT transparency (png, webp) and avoid formats that DONT (e.g. jpeg).
Notes:
Does not support local blocks - as, well, they are LOCAL to a sprite/stage.
Best to run this script in normal theme (no block fading, no flat design, 1x block zoom) so the blocks can look the same.
A example custom block category is provided, "Blocks", which contain two examples on how to use the documentation blocks.
If any bugs occur, please tell me at the forum page.