The developer.rhino3d.com website contents
HTML CSS C# Ruby Python Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data rss api docs update Apr 24, 2018
_guide_topics Fixed typo in Options Pages Best Practices Jul 24, 2018
_includes Direct users to Grasshopper landing pages. May 23, 2018
_layouts rhinoscriptsyntax online API docs: add rss specific search box. Addre… Feb 22, 2018
_posts Make note about blog aggregator Jun 16, 2015
_samples This sample is obsolete Mar 9, 2018
_sass Redirect mac/win rss docs to undecorated url Sep 5, 2017
api Re-add proper chm file for rhinocommon api Aug 9, 2018
css Initial commit of Task enabled articles. May 11, 2018
files Update mcneelcodesigning.zip file with correct CA.crt (again) Dec 4, 2017
images Update the Yak documentation Jul 9, 2018
node_modules/highlightjs-line-numbers.js Updated the WIP branch to run Line numbers. Runs locally Feb 8, 2017
script Fix travis build when using cache Mar 19, 2018
.gitignore Fix travis build when using cache Mar 19, 2018
.gitmodules Remove obsolete windows-only rhinocommon api docs Feb 28, 2018
.nojekyll Build various version branches using build script and travis-ci May 9, 2016
.ruby-version Replace rvm config in .travis.yml with .ruby-version Aug 11, 2017
.travis.yml Checkout lfs objects in submodules Aug 9, 2018
CNAME Working on MR-2135 Jul 6, 2015
CONTRIBUTING.md Create a basic CONTRIBUTING.md Mar 27, 2018
Gemfile Fix "edit on github" links Nov 10, 2016
README.md Fix dead link and typo in readme Mar 27, 2018
_config.yml Fix travis build when using cache Mar 19, 2018
_config_dev.yml Ignore everything in dev config, not just api Jul 9, 2018
admin.md Switch many hardcoded branch links to branch variables Aug 25, 2017
api.md Add "new window" glyph to api links Nov 28, 2017
blog.md toc-page template generates TOC automatically Jun 25, 2015
favicon.ico Change favicon and include touch icons for mobile devices Feb 27, 2016
feed.xml first commit Jun 9, 2015
guides.md Render Engine guides deserve their own category Mar 15, 2018
index.md Direct users to Grasshopper landing pages. May 23, 2018
samples.md Rename apis yaml field to sdk Mar 17, 2017
search-results.md Added the new Bing custom search to the site. Dec 12, 2017
videos.md Add link to C# workshop handouts Dec 13, 2017

README.md

developer-rhino3d-com

Build Status

This repo contains the contents of http://developer.rhino3d.com.

The site is hosted on GitHub Pages which uses a static site generator called Jekyll.

Getting Started

These instructions cover running this project locally on both macOS and Windows so that you can preview changes before pushing them to GitHub Pages.

First, navigate somewhere safe and clone the repository.

git clone https://github.com/mcneel/developer-rhino3d-com.git

If you are not comfortable using git on the command-line, then try GitHub for Mac and GitHub for Windows. There's also the git cheat sheet.

IMPORTANT: The site is branch-aware and automatically deployed by Travis CI. DO NOT PUSH TO THE gh-pages BRANCH!

The current (stable) version of Rhino is defined in the stable: field in the _config.yml file. The n branch that corresponds to the stable release is built and deployed to http://developer.rhino3d.com.

The master branch represents the WIP version of the site. Changes to the master branch will be built by Travis and deployed to http://developer.rhino3d.com/wip.

Branches are defined in _config.yml (under version_branches) and will be built and deployed into a subpath with the same name; for example: the 5 branch is built and deployed to http://developer.rhino3d.com/5.

macOS

macOS ships with Ruby and RubyGems, however it's not wise to mess around with this installation. Instead, install your own Ruby using Homebrew (and optionally rbenv).

Install Homebrew

As per the Homebrew website, install via the following one-liner (which will prompt you to install the Xcode Command Line Tools, if you don't already have them).

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Install Ruby (the easy way)

Note: Since OS X 10.11 (El Capitan) we've seen failures during the gem install step (ERROR: While executing gem ... (Errno::EINVAL)) on machines that didn't previously have homebrew installed. Using rbenv seems to solve this.

Simply brew Ruby.

brew install ruby

Now close and reopen the Terminal window to make sure the system knows about the new version of Ruby and skip to installing Jekyll.

Install Ruby (the rbenv way)

This is a slightly more advanced method for installing ruby which allows you to easily switch between ruby versions.

Install rbenv and ruby-build using homebrew:

brew install rbenv ruby-build

Run rbenv init which will prompt you to add eval "$(rbenv init -)" to ~/.bash_profile. Do this.

Install ruby (see .ruby-version for the current version):

rbenv install 2.3.3

Check that everything worked as expected:

  1. ruby --version – should return something like ruby 2.3.3p222 (2016-11-21 revision 56859) [universal.x86_64-darwin17]
  2. which ruby – should return something like /Users/will/.rbenv/shims/ruby (not /usr/bin/ruby or /usr/local/bin/ruby)

Install Jekyll

The GitHub Pages Ruby Gem provides the same version of Jekyll as exists on the GitHub Pages servers. This ensures we aren't accidentally using features that have either been deprecated or simply don't exist on GitHub's servers yet!

gem install github-pages

You can now serve your local copy of this site by running the following commands, remembering to replace CLONE_DIRECTORY with the location to which you checked out this repository.

cd CLONE_DIRECTORY
script/server

Navigate to http://localhost:4000 in your browser to view the site.

Note: The api directory is excluded when previewing the site locally which speeds things up a bit!

Windows

While Jekyll is not officially supported in Windows, it does work. These instructions are based on the official unofficial guide to installing Jekyll on Windows.

Optionally, you can follow the directions found on Setting up your GitHub Pages site locally with Jekyll - Windows to use Bundler to install Jekyll.

Install Ruby and Ruby DevKit

Go to http://rubyinstaller.org/downloads/ and download the installer for Ruby that matches your system architecture (x86/x64). Check .ruby-version for the current recommended version.

At the "Installation Destination and Optional Tasks" dialog, make sure to check the "Add Ruby executable to your PATH" box.

Then, from the same page download the Development Kit that corresponds to your Ruby installation. Jekyll won't be fully functional without this.

Run the self extracting archive, entering the path C:\RubyDevKit when prompted.

To initialize and install the DevKit, open up a command prompt and roll up your sleeves...

cd C:\RubyDevKit
ruby dk.rb init
ruby dk.rb install

Install Jekyll and serve

As with macOS, install the GitHub Pages Ruby Gem, navigate to the clone directory and run jekyll.

gem install github-pages
cd CLONE_DIRECTORY
jekyll serve

Next Steps

Once you have cloned or forked this repository and are able to build it locally, please read the following guides: