scratchfoundation/scratchblocks
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratchblocks.git synced 2024-11-30 19:27:05 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
Make pictures of Scratch blocks from text.
372 commits 8 branches 9 tags 1.5 MiB
JavaScript 96.3%
HTML 1.6%
Python 1.2%
CSS 0.8%
Makefile 0.1%
Find a file
Tim (blob8108) ded284f6e7 Add homepage repo link
2016-04-15 22:10:51 +01:00
.github Add homepage repo link 2016-04-15 22:10:51 +01:00
src Remove classList 2016-04-15 19:11:45 +01:00
tests add test for unicode image symbols 2016-02-22 13:37:41 +00:00
.gitignore Add build to gitignore 2016-04-11 00:12:43 +01:00
LICENSE Rename scratchblocks2 -> scratchblocks 2016-02-22 13:37:41 +00:00
Makefile Drop diacritics.js 2016-04-11 11:02:27 +01:00
package.json Fix clean-css package name 2016-04-09 15:19:49 +01:00
README.md Update Readme 2016-04-15 21:08:15 +01:00

README.md

Make pictures of Scratch blocks from text.

Screenshot

Try it out!

scratchblocks is used to write Scratch scripts:

It's MIT licensed, so you can use it in your projects. (But do send me a link on Twitter!)

For the full guide to the syntax, see the wiki.

Usage

MediaWiki

Use the MediaWiki plugin. This is what the Scratch Wiki uses.

It doesn't support other languages yet. Sorry about that. (But the German Scratch wiki people seem to be working on this.)

WordPress

I found a WordPress plugin. It might work for you; I haven't tried it.

Pandoc

Code Club use their own lesson_format tool to generate the PDF versions of their project guides. It uses the pandoc_scratchblocks plugin they wrote to make pictures of Scratch scripts.

This would probably be a good way to write a Scratch book.

Markdown

By using codeclub_lesson_builder you can include scratch code directly in markdown codeblocks like this:

```blocks
when flag clicked
go to x:(-50) y:(0)
```

The markdown builds to HTML and PDF.

HTML

Include the scratchblocks JS file on your webpage:

<script src="//scratchblocks.github.io/js/scratchblocks-3.x-min.js"></script>

Then just call scratchblocks.renderMatching after the page has loaded, which will render matching page elements to shiny scratch blocks. Its sole argument is the CSS-style selector for the elements that contain the scratchblocks code. It uses pre.blocks by default.

scratchblocks.renderMatching("pre.blocks");

Use make, or your preferred build tool, to minify the assets. You'll need to install some dependencies first:

  • Try npm install
  • Try brew install zopfli, or the equivalent command for your preferred package manager.

Inline blocks

To use blocks inside a paragraph...

I'm rather fond of the <code class="b">stamp</code> block in Scratch.

...make a separate call to renderMatching using the inline argument.

scratchblocks.renderMatching("code.b", {inline: true});

Languages

translations.js contains all the languages needed on the Scratch Forums.

translations-all.js contains all the languages Scratch supports.

scratchblocks also requires some additional words which aren't in Scratch itself (mainly the words used for the flag and arrow images). I'd be happy to accept pull requests for those!

Development

See CONTRIBUTING.md.

Credits

Many, many thanks to the contributors!

  • Authored by tjvr
  • SVG proof-of-concept, shapes & filters by as-com
  • Anna helped with a formula, and pointed out that I can't read graphs
  • JSO designed the syntax and wrote the original Block Plugin
  • Help with translation code from joooni
  • Block translations from the Scratch translation server