diff --git a/Gruntfile.js b/Gruntfile.js index a62f5235a..67af9b044 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -269,11 +269,13 @@ module.exports = function(grunt) { fritzing: hasFzz ? templates.fritzing({ fzz: fzz }) : "" }; - // Write the file to /docs/* - file.write(md, templates[tplType](values)); + if (titles[value]) { + // Write the file to /docs/* + file.write(md, templates[tplType](values)); - // Push a rendered markdown link into the readme "index" - readme.push(templates.eglink(values)); + // Push a rendered markdown link into the readme "index" + readme.push(templates.eglink(values)); + } }); }); diff --git a/README.md b/README.md index d0220e2ed..1038cb8dd 100644 --- a/README.md +++ b/README.md @@ -197,7 +197,7 @@ board.on("ready", function() { ### Servo - [Servo Component](https://github.com/rwaldron/johnny-five/blob/master/docs/servo.md) - [Continuous Servo Component](https://github.com/rwaldron/johnny-five/blob/master/docs/servo-continuous.md) -- [Servo - Slider](https://github.com/rwaldron/johnny-five/blob/master/docs/servo-slider.md) +- [Servo - Slide Potentiometer Controller](https://github.com/rwaldron/johnny-five/blob/master/docs/servo-slider.md) - [Servo - Prompt](https://github.com/rwaldron/johnny-five/blob/master/docs/servo-prompt.md) - [Servo - Drive](https://github.com/rwaldron/johnny-five/blob/master/docs/servo-drive.md) - [Servo - Animation](https://github.com/rwaldron/johnny-five/blob/master/docs/servo-animation.md) @@ -270,9 +270,9 @@ board.on("ready", function() { ### Compass/Magnetometer - [Compass (HMC6352)](https://github.com/rwaldron/johnny-five/blob/master/docs/compass-hmc6352.md) - [Compass (HMC5883L)](https://github.com/rwaldron/johnny-five/blob/master/docs/compass-hmc5883l.md) -- [Magnetometer log](https://github.com/rwaldron/johnny-five/blob/master/docs/magnetometer-log.md) -- [Magnetometer north](https://github.com/rwaldron/johnny-five/blob/master/docs/magnetometer-north.md) -- [Magnetometer Component](https://github.com/rwaldron/johnny-five/blob/master/docs/magnetometer.md) +- [Compass/Magnetometer - Logging](https://github.com/rwaldron/johnny-five/blob/master/docs/magnetometer-log.md) +- [Compass/Magnetometer - Find North](https://github.com/rwaldron/johnny-five/blob/master/docs/magnetometer-north.md) +- [Compass/Magnetometer Component](https://github.com/rwaldron/johnny-five/blob/master/docs/magnetometer.md) ### Piezo - [Piezo Component](https://github.com/rwaldron/johnny-five/blob/master/docs/piezo.md) @@ -291,16 +291,11 @@ board.on("ready", function() { - [Gyro - Analog (LPR5150AL)](https://github.com/rwaldron/johnny-five/blob/master/docs/gyro-lpr5150l.md) - [Gyro - I2C (MPU6050)](https://github.com/rwaldron/johnny-five/blob/master/docs/gyro-mpu6050.md) - [Sensor - Photoresistor](https://github.com/rwaldron/johnny-five/blob/master/docs/photoresistor.md) -- [](https://github.com/rwaldron/johnny-five/blob/master/docs/photoresistor-servo.md) - [Sensor - Potentiometer](https://github.com/rwaldron/johnny-five/blob/master/docs/potentiometer.md) - [Sensor Component](https://github.com/rwaldron/johnny-five/blob/master/docs/sensor.md) - [Sensor - Force Sensitive Servo Controller](https://github.com/rwaldron/johnny-five/blob/master/docs/sensor-fsr-servo.md) -- [](https://github.com/rwaldron/johnny-five/blob/master/docs/sensor-fsr.md) -- [](https://github.com/rwaldron/johnny-five/blob/master/docs/sensor-ir-led-receiver.md) - [Sensor - Slide Potentiometer](https://github.com/rwaldron/johnny-five/blob/master/docs/sensor-slider.md) -- [](https://github.com/rwaldron/johnny-five/blob/master/docs/slider-log.md) -- [](https://github.com/rwaldron/johnny-five/blob/master/docs/slider-pan.md) -- [Sensor - Slider Potentiometer Servo Controller](https://github.com/rwaldron/johnny-five/blob/master/docs/slider-servo-control.md) +- [Sensor - Slide Potentiometer Servo Controller](https://github.com/rwaldron/johnny-five/blob/master/docs/slider-servo-control.md) - [Temperature (TMP36)](https://github.com/rwaldron/johnny-five/blob/master/docs/temperature-tmp36.md) - [Temperature (LM35)](https://github.com/rwaldron/johnny-five/blob/master/docs/temperature-lm35.md) - [Temperature (DS18B20)](https://github.com/rwaldron/johnny-five/blob/master/docs/temperature-ds18b20.md) @@ -319,18 +314,17 @@ board.on("ready", function() { - [Grove Servo](https://github.com/rwaldron/johnny-five/blob/master/docs/grove-servo.md) ### TinkerKit -- [TinkerKit Accelerometer](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-accelerometer.md) -- [TinkerKit blink](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-blink.md) -- [TinkerKit Button](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-button.md) -- [TinkerKit continuous Servo](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-continuous-servo.md) -- [TinkerKit combo](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-combo.md) -- [TinkerKit gyroscope](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-gyroscope.md) -- [TinkerKit joystick](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-joystick.md) -- [TinkerKit linear pot](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-linear-pot.md) -- [TinkerKit rotary](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-rotary.md) -- [TinkerKit thermistor](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-thermistor.md) -- [TinkerKit tilt](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-tilt.md) -- [TinkerKit touch](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-touch.md) +- [TinkerKit - Accelerometer](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-accelerometer.md) +- [TinkerKit - Blink](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-blink.md) +- [TinkerKit - Button](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-button.md) +- [TinkerKit - Continuous Servo](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-continuous-servo.md) +- [TinkerKit - Combo](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-combo.md) +- [TinkerKit - Gyro](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-gyroscope.md) +- [TinkerKit - Joystick](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-joystick.md) +- [TinkerKit - Linear Potentiometer](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-linear-pot.md) +- [TinkerKit - Rotary Potentiometer](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-rotary.md) +- [TinkerKit - Tilt Sensor](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-tilt.md) +- [TinkerKit - Touch Sensor](https://github.com/rwaldron/johnny-five/blob/master/docs/tinkerkit-touch.md) ### Wii - [Wii Nunchuk Component](https://github.com/rwaldron/johnny-five/blob/master/docs/nunchuk.md) diff --git a/docs/magnetometer-log.md b/docs/magnetometer-log.md index 9eeb3aa15..7b57bd13f 100644 --- a/docs/magnetometer-log.md +++ b/docs/magnetometer-log.md @@ -1,5 +1,5 @@ -# Magnetometer log +# Compass/Magnetometer - Logging Run with: ```bash diff --git a/docs/magnetometer-north.md b/docs/magnetometer-north.md index dfebd0ac7..17959ffc7 100644 --- a/docs/magnetometer-north.md +++ b/docs/magnetometer-north.md @@ -1,5 +1,5 @@ -# Magnetometer north +# Compass/Magnetometer - Find North Run with: ```bash diff --git a/docs/magnetometer.md b/docs/magnetometer.md index ecdb9d688..11fa55d5f 100644 --- a/docs/magnetometer.md +++ b/docs/magnetometer.md @@ -1,5 +1,5 @@ -# Magnetometer Component +# Compass/Magnetometer Component Run with: ```bash diff --git a/docs/servo-slider.md b/docs/servo-slider.md index 147bdeee7..d6593e633 100644 --- a/docs/servo-slider.md +++ b/docs/servo-slider.md @@ -1,5 +1,5 @@ -# Servo - Slider +# Servo - Slide Potentiometer Controller Run with: ```bash diff --git a/docs/slider-servo-control.md b/docs/slider-servo-control.md index f8206026b..4bd10ccc8 100644 --- a/docs/slider-servo-control.md +++ b/docs/slider-servo-control.md @@ -1,5 +1,5 @@ -# Sensor - Slider Potentiometer Servo Controller +# Sensor - Slide Potentiometer Servo Controller Run with: ```bash diff --git a/docs/tinkerkit-accelerometer.md b/docs/tinkerkit-accelerometer.md index cf6eee597..d13811ca1 100644 --- a/docs/tinkerkit-accelerometer.md +++ b/docs/tinkerkit-accelerometer.md @@ -1,5 +1,5 @@ -# TinkerKit Accelerometer +# TinkerKit - Accelerometer Run with: ```bash diff --git a/docs/tinkerkit-blink.md b/docs/tinkerkit-blink.md index 39ca6353b..1e57e71e5 100644 --- a/docs/tinkerkit-blink.md +++ b/docs/tinkerkit-blink.md @@ -1,5 +1,5 @@ -# TinkerKit blink +# TinkerKit - Blink Run with: ```bash diff --git a/docs/tinkerkit-button.md b/docs/tinkerkit-button.md index 22089d12b..5e6a66d43 100644 --- a/docs/tinkerkit-button.md +++ b/docs/tinkerkit-button.md @@ -1,5 +1,5 @@ -# TinkerKit Button +# TinkerKit - Button Run with: ```bash diff --git a/docs/tinkerkit-combo.md b/docs/tinkerkit-combo.md index 45795a052..a32342a21 100644 --- a/docs/tinkerkit-combo.md +++ b/docs/tinkerkit-combo.md @@ -1,5 +1,5 @@ -# TinkerKit combo +# TinkerKit - Combo Run with: ```bash diff --git a/docs/tinkerkit-continuous-servo.md b/docs/tinkerkit-continuous-servo.md index 1b67d977a..a9a667b11 100644 --- a/docs/tinkerkit-continuous-servo.md +++ b/docs/tinkerkit-continuous-servo.md @@ -1,5 +1,5 @@ -# TinkerKit continuous Servo +# TinkerKit - Continuous Servo Run with: ```bash diff --git a/docs/tinkerkit-gyroscope.md b/docs/tinkerkit-gyroscope.md index 504fac943..c4b91d010 100644 --- a/docs/tinkerkit-gyroscope.md +++ b/docs/tinkerkit-gyroscope.md @@ -1,5 +1,5 @@ -# TinkerKit gyroscope +# TinkerKit - Gyro Run with: ```bash diff --git a/docs/tinkerkit-joystick.md b/docs/tinkerkit-joystick.md index 998c6d670..08d1f9f3a 100644 --- a/docs/tinkerkit-joystick.md +++ b/docs/tinkerkit-joystick.md @@ -1,5 +1,5 @@ -# TinkerKit joystick +# TinkerKit - Joystick Run with: ```bash diff --git a/docs/tinkerkit-linear-pot.md b/docs/tinkerkit-linear-pot.md index 68df40fc1..59a583f5a 100644 --- a/docs/tinkerkit-linear-pot.md +++ b/docs/tinkerkit-linear-pot.md @@ -1,5 +1,5 @@ -# TinkerKit linear pot +# TinkerKit - Linear Potentiometer Run with: ```bash diff --git a/docs/tinkerkit-rotary.md b/docs/tinkerkit-rotary.md index 28e02dea4..1063e9bd4 100644 --- a/docs/tinkerkit-rotary.md +++ b/docs/tinkerkit-rotary.md @@ -1,5 +1,5 @@ -# TinkerKit rotary +# TinkerKit - Rotary Potentiometer Run with: ```bash diff --git a/docs/tinkerkit-thermistor.md b/docs/tinkerkit-thermistor.md index 67fe72654..e0e951c50 100644 --- a/docs/tinkerkit-thermistor.md +++ b/docs/tinkerkit-thermistor.md @@ -1,5 +1,5 @@ -# TinkerKit thermistor +# Run with: ```bash diff --git a/docs/tinkerkit-tilt.md b/docs/tinkerkit-tilt.md index 557374378..897bb43b3 100644 --- a/docs/tinkerkit-tilt.md +++ b/docs/tinkerkit-tilt.md @@ -1,5 +1,5 @@ -# TinkerKit tilt +# TinkerKit - Tilt Sensor Run with: ```bash diff --git a/docs/tinkerkit-touch.md b/docs/tinkerkit-touch.md index 4ad947e4a..59204b937 100644 --- a/docs/tinkerkit-touch.md +++ b/docs/tinkerkit-touch.md @@ -1,5 +1,5 @@ -# TinkerKit touch +# TinkerKit - Touch Sensor Run with: ```bash diff --git a/tpl/titles.json b/tpl/titles.json index cb8eb3668..2340295cb 100644 --- a/tpl/titles.json +++ b/tpl/titles.json @@ -19,9 +19,9 @@ "servo.js": "Servo Component", "servo-continuous.js": "Continuous Servo Component", "servo-sweep.js": "Servo - Sweep", - "servo-slider.js": "Servo - Slider", + "servo-slider.js": "Servo - Slide Potentiometer Controller", "servo-prompt.js": "Servo - Prompt", - "servo-keypress.js": "Servo - Keypress", + "servo-keypress.js": "Servo - Keypress Controller", "servo-drive.js": "Servo - Drive", "servo-animation.js": "Servo - Animation", "servo-diagnostic.js": "Servo - Diagnostic", @@ -81,13 +81,9 @@ "led-matrix-HT16K33.js": "LED - Matrix (HT16K33)", "seven-segment.js": "Shift Register - Seven Segment Controller", "laser.js": "LED - Laser", - "magnetometer-log.js": "Magnetometer log", - "magnetometer-north.js": "Magnetometer north", - "magnetometer.js": "Magnetometer Component", - "nodeconf-compass.js": "NodeConf Compass", - "nodeconf-navigator.js": "NodeConf Navigator", - "nodeconf-radar.js": "NodeConf Radar", - "nodeconf-slider.js": "NodeConf Slider", + "magnetometer-log.js": "Compass/Magnetometer - Logging", + "magnetometer-north.js": "Compass/Magnetometer - Find North", + "magnetometer.js": "Compass/Magnetometer Component", "piezo.js": "Piezo Component", "kinect-arm-controller.js": "Kinect Arm Controller", "nunchuk.js": "Wii Nunchuk Component", @@ -104,7 +100,7 @@ "sensor.js": "Sensor Component", "sensor-fsr-servo.js": "Sensor - Force Sensitive Servo Controller", "sensor-slider.js": "Sensor - Slide Potentiometer", - "slider-servo-control.js": "Sensor - Slider Potentiometer Servo Controller", + "slider-servo-control.js": "Sensor - Slide Potentiometer Servo Controller", "temperature-tmp36.js": "Temperature (TMP36)", "temperature-lm35.js": "Temperature (LM35)", "temperature-ds18b20.js": "Temperature (DS18B20)", @@ -116,18 +112,17 @@ "grove-lcd-rgb.js": "Grove LCD RGB", "grove-lcd-rgb-temperature-display.js": "Grove LCD RGB Temperature display", "grove-servo.js": "Grove Servo", - "tinkerkit-accelerometer.js": "TinkerKit Accelerometer", - "tinkerkit-blink.js": "TinkerKit blink", - "tinkerkit-button.js": "TinkerKit Button", - "tinkerkit-continuous-servo.js": "TinkerKit continuous Servo", - "tinkerkit-combo.js": "TinkerKit combo", - "tinkerkit-gyroscope.js": "TinkerKit gyroscope", - "tinkerkit-joystick.js": "TinkerKit joystick", - "tinkerkit-linear-pot.js": "TinkerKit linear pot", - "tinkerkit-rotary.js": "TinkerKit rotary", - "tinkerkit-thermistor.js": "TinkerKit thermistor", - "tinkerkit-tilt.js": "TinkerKit tilt", - "tinkerkit-touch.js": "TinkerKit touch", + "tinkerkit-accelerometer.js": "TinkerKit - Accelerometer", + "tinkerkit-blink.js": "TinkerKit - Blink", + "tinkerkit-button.js": "TinkerKit - Button", + "tinkerkit-continuous-servo.js": "TinkerKit - Continuous Servo", + "tinkerkit-combo.js": "TinkerKit - Combo", + "tinkerkit-gyroscope.js": "TinkerKit - Gyro", + "tinkerkit-joystick.js": "TinkerKit - Joystick", + "tinkerkit-linear-pot.js": "TinkerKit - Linear Potentiometer", + "tinkerkit-rotary.js": "TinkerKit - Rotary Potentiometer", + "tinkerkit-tilt.js": "TinkerKit - Tilt Sensor", + "tinkerkit-touch.js": "TinkerKit - Touch Sensor", "led-blink.js": "LED - Blink", "led-digits-clock.js": "LED - Digital Clock", "led-matrix-tutorial.js": "LED - Matrix Demo",