andy/planetary.js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add more documentation

Browse Source
This commit is contained in:
Brandon Tilley 2013-12-21 21:04:59 -08:00
parent 6ac19dd19c
commit 2a6237411c
3 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
site/public/_menu.ejs
View File

@ -7,10 +7,10 @@
<a class='item minor' href='https://github.com/BinaryMuse/planetary.js/releases'> <a class='item minor' href='https://github.com/BinaryMuse/planetary.js/releases'>
<i class='download icon'></i><span class='hide-on-mobile'>Download</span> <i class='download icon'></i><span class='hide-on-mobile'>Download</span>
</a> </a>
<a class='item minor' href='/examples/'> <a class='item minor <%- current.path[0] == 'examples' ? 'active' : '' %>' href='/examples/'>
<i class='laptop icon'></i><span class='hide-on-mobile'>Examples</span> <i class='laptop icon'></i><span class='hide-on-mobile'>Examples</span>
</a> </a>
<a class='item minor' href='/documentation/'> <a class='item minor <%- current.path[0] == 'documentation' ? 'active' : '' %>' href='/documentation/'>
<i class='book icon'></i><span class='hide-on-mobile'>Documentation</span> <i class='book icon'></i><span class='hide-on-mobile'>Documentation</span>
</a> </a>
<a class='item minor' href='https://github.com/BinaryMuse/planetary.js'> <a class='item minor' href='https://github.com/BinaryMuse/planetary.js'>

10
site/public/documentation/_layout.ejs
View File

@ -11,23 +11,23 @@
<div class='page ui slim stackable grid'> <div class='page ui slim stackable grid'>
<div class='four wide column'> <div class='four wide column'>
<div class='ui fluid vertical menu'> <div class='ui fluid vertical menu'>
<a class='item <%- current.source == 'index' ? 'active' : '' %>' href='/documentation/index.html'> <a class='red item <%- current.source == 'index' ? 'active' : '' %>' href='/documentation/index.html'>
Introduction Introduction
<i class='icon home'></i> <i class='icon home'></i>
</a> </a>
<a class='item <%- current.source == 'core' ? 'active' : '' %>' href='/documentation/core.html'> <a class='blue item <%- current.source == 'core' ? 'active' : '' %>' href='/documentation/core.html'>
Core API Core API
<i class='icon setting'></i> <i class='icon setting'></i>
</a> </a>
<a class='item <%- current.source == 'planet' ? 'active' : '' %>' href='/documentation/planet.html'> <a class='orange item <%- current.source == 'planet' ? 'active' : '' %>' href='/documentation/planet.html'>
Planet API Planet API
<i class='icon globe'></i> <i class='icon globe'></i>
</a> </a>
<a class='item <%- current.source == 'plugins' ? 'active' : '' %>' href='/documentation/plugins.html'> <a class='teal item <%- current.source == 'plugins' ? 'active' : '' %>' href='/documentation/plugins.html'>
Plugins Plugins
<i class='icon edit'></i> <i class='icon edit'></i>
</a> </a>
<a class='item with-subitems <%- current.source == 'builtin' ? 'active' : '' %>' href='/documentation/builtin.html'> <a class='green item with-subitems <%- current.source == 'builtin' ? 'active' : '' %>' href='/documentation/builtin.html'>
Built-In Plugins Built-In Plugins
<i class='icon bolt'></i> <i class='icon bolt'></i>
</a> </a>

11
site/public/documentation/builtin.md
View File

@ -1,2 +1,13 @@
Built-In Plugins Built-In Plugins
================ ================
Planetary.js comes with several built-in plugins that provide a base set of functionality. (Note that the `planetaryjs-noplugins.js` file, as its name suggests, does not include the plugins). They are described in detail on their own pages, but are:
* [Earth](/documentation/builtin_earth.html) - a combination of the `topojson`, `oceans`, `land`, and `borders` plugins.
* [TopoJSON](/documentation/builtin_topojson.html) - loads TopoJSON data via Ajax (or via configuration) and makes it available for use by other plugins
* [Oceans](/documentation/builtin_oceans.html) - fills in the globe with a solid color (and an optional stroke)
* [Land](/documentation/builtin_land.html) - uses data from the `topojson` plugin to draw Earth's land masses
* [Borders](/documentation/builtin_borders.html) - uses data from the `topojson` plugin to draw borders between Earth's countries
* [Pings](/documentation/builtin_pings.html) - draws animated, circular pings on the globe
* [Zoom](/documentation/builtin_zoom.html) - enables mouse-based zooming of the globe via the mousewheel
* [Drag](/documentation/builtin_drag.html) - enables mouse-based rotation of the globe via dragging