scratchfoundation/scratch-extension-docs
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratch-extension-docs.git synced 2024-11-27 01:45:44 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
[Deprecated] Sample code for Scratch 2.0 hardware and web extensions.
39 commits 2 branches 0 tags 536 KiB
Find a file
Ray Schamp ec1a2f54be Redirect traffic to ScratchX
2015-05-15 13:56:53 -04:00
_layouts Converted site to use Jekyll 2014-08-01 20:03:01 -07:00
images fix images 2015-05-07 16:49:37 -04:00
stylesheets Create gh-pages branch via GitHub 2014-05-15 21:11:16 -04:00
.DS_Store added FAQs 2015-05-07 20:07:32 -04:00
.gitignore Converted site to use Jekyll 2014-08-01 20:03:01 -07:00
_config.yml Converted site to use Jekyll 2014-08-01 20:03:01 -07:00
Gemfile Converted site to use Jekyll 2014-08-01 20:03:01 -07:00
Gemfile.lock Converted site to use Jekyll 2014-08-01 20:03:01 -07:00
index.md Redirect traffic to ScratchX 2015-05-15 13:56:53 -04:00
README.md Update README.md 2015-04-16 10:58:00 -07:00

README.md

See Using Jekyll with Pages for help with editing this content.

Quick start

  1. Verify that you have Ruby (version 1.9.3 or 2.0.0)
  2. Run gem install bundler
  3. Clone this repository and switch to the gh-pages branch
  4. In your cloned repository, run bundle install
  5. Run bundle exec jekyll serve to preview your site at http://localhost:4000

Windows users

Jekyll isn't really designed with Windows in mind, but it's not too hard to get it working with Cygwin. Follow the 'Installing Jekyll' steps on the GitHub help page above after installing Cygwin with the following packages. If you get errors from the bundle install step, you're probably missing a package -- most likely, a *-devel library package. If it's not listed below, please add it!

Required Cygwin packages:

  • ruby (version 1.9.3 or 2.0.0)
  • gcc-core
  • libcrypt-devel
  • libiconv-devel
  • libffi-devel
  • make
  • patch
  • pkg-config
  • zlib-devel

Note that bundle install will likely take quite a while, and may appear to hang.

Even with all the required packages, Jekyll on Windows doesn't seem to like running in --watch mode. This might be fixed by downgrading the listen package, but doing so means downgrading many other packages and potentially breaking compatibility.

Troubleshooting

Nokogiri fails to build

This appears to be a bug related to Cygwin and certain versions of Nokogiri. As a workaround, you'll need to install a few more Cygwin packages:

  • libxml2-devel
  • libxslt-devel
  • ruby-nokogiri

Then, run this command:

bundle config build.nokogiri --use-system-libraries

After this, bundle install will use the version of Nokogiri installed by Cygwin rather than trying to download and build a new one.

Permission denied

If you get "permission denied" related to conftest.exe while running bundle install, you may need to temporarily disable your virus protection. Remember to turn it on again after installation!

Jekyll fails to build your site

If Jekyll fails to build your site, you may need to provide a "fixed" version of your COMSPEC environment variable. The easiest way to do that is:

export COMSPEC=`cygpath -u "$COMSPEC"`

You can either run that command in your shell yourself, add it to .bashrc, or add it to a shell script that (for example) runs bundle exec jekyll serve for you.