point web links to narakeet

narakeet · Sep 5, 2020 · 2b40f75 · 2b40f75 · miniminsano · Jun 29, 2024
1 parent 479c064
commit 2b40f75
Show file tree

Hide file tree

Showing 20 changed files with 74 additions and 68 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,17 @@
-# Video Puppet Examples
+# Narakeet Examples
 
-This repository contains samples and examples for [Video Puppet](https://www.videopuppet.com) scripts.
+This repository contains samples and examples for [Narakeet](https://www.narakeet.com) (formerly Video Puppet).
 
 ## Start here
 
 * [Hello World](hello-world/README.md) - basic script structure, adding images, audio and video
 
+## Full examples for typical use cases
+
+* [Screencast](screencast-demo-video/) - how to create a narrated screencast video (from screenshots/recordings)
+* [Code Tutorial](code-tutorial-demo-video/) - how to create a code tutorial (with syntax highlighting)
+* [Quick announcement](feature-announcement-demo-video) - how to create a quick feature demo or announcement
+
 ## Managing narration
 
 * [voices](voices/README.md): controlling the narration voice

diff --git a/background-audio/README.md b/background-audio/README.md
@@ -1,12 +1,12 @@
-# Video Puppet background sounds example 
+# Narakeet background sounds example 
 
-This example shows how to add a background audio to Video Puppet. 
+This example shows how to add a background audio to Narakeet. 
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 
@@ -34,4 +34,4 @@ background: sound.wav 0.5
 
 ## Related examples
 
-You can use some royalty-free sounds provided by Video Puppet directly without uploading your own files. Check out the [Vendor Audio Example](../vendor-audio/README.md).
+You can use some royalty-free sounds provided by Narakeet directly without uploading your own files. Check out the [Vendor Audio Example](../vendor-audio/README.md).
diff --git a/callouts/README.md b/callouts/README.md
@@ -1,12 +1,12 @@
-# Video Puppet call-outs example 
+# Narakeet call-outs example 
 
-This example shows how to add call-outs to highlight important parts of a slide in Video Puppet. 
+This example shows how to add call-outs to highlight important parts of a slide in Narakeet. 
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 

diff --git a/gifs/README.md b/gifs/README.md
@@ -1,12 +1,12 @@
 # Creating a video from animated GIFs 
 
-This example shows how to include animated GIFs into videos using Video Puppet. 
+This example shows how to include animated GIFs into videos using Narakeet. 
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 
@@ -34,4 +34,4 @@ To loop a GIF without any narration, or for longer than the duration of the audi
 
 ## Supported synchronisation options
 
-Check out [Using Animated GIFs](https://videopuppet.com/docs/format/#using-animated-gifs) for more information on scene synchronization options.
+Check out [Using Animated GIFs](https://www.narakeet.com/docs/format/#using-animated-gifs) for more information on scene synchronization options.
diff --git a/hello-world/README.md b/hello-world/README.md
@@ -1,16 +1,16 @@
-# Basic Video Puppet example
+# Basic Narakeet example
 
-This example shows how the basic features of Video Puppet.
+This example shows how the basic features of Narakeet.
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 
-Video Puppet creates a video from one or scenes. Each scene can include videos, images, audio or narration. 
+Narakeet creates a video from one or scenes. Each scene can include videos, images, audio or narration. 
 
 ### Adding images and videos
 
@@ -22,7 +22,7 @@ In the Markdown script file format, you can add images or videos by using the st
 
 ### Adding narration
 
-Video Puppet automatically generates narration from scene text. The following scene will include an image, and automatically generated voice narration:
+Narakeet automatically generates narration from scene text. The following scene will include an image, and automatically generated voice narration:
 
 ```md
 ![](london.jpg)

diff --git a/hello-world/script/source.md b/hello-world/script/source.md
@@ -2,7 +2,7 @@
 
 ![](london.jpg)
 
-<!-- Video Puppet will automatically generate voice from text for scene narration -->
+<!-- Narakeet will automatically generate voice from text for scene narration -->
 
 Welcome to London
 
@@ -20,7 +20,7 @@ Welcome to Berlin
 
 <!-- 
 
-Stage directions tell Video Puppet how to build a scene, in the format:
+Stage directions tell Narakeet how to build a scene, in the format:
 
 (property: value) 
 

diff --git a/image-sizing/README.md b/image-sizing/README.md
@@ -1,22 +1,22 @@
-# Video Puppet image sizing example 
+# Narakeet image sizing example 
 
-This example shows how to automatically resize images to fit the output format in Video Puppet. 
+This example shows how to automatically resize images to fit the output format in Narakeet. 
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 
-When adding an image to a scene, Video Puppet will automatically resize it to fit the target video format. You can control resizing by adding an option to the square brackets when setting the video. For example, to shrink and pad a larger image to fit the smaller target size, use the `contain` option:
+When adding an image to a scene, Narakeet will automatically resize it to fit the target video format. You can control resizing by adding an option to the square brackets when setting the video. For example, to shrink and pad a larger image to fit the smaller target size, use the `contain` option:
 
 ```md
 ![contain](image.png)
 ```
 
-Without additional options, Video Puppet will crop a large image around the center to cover the video size. If you want to show a different part of the image, specify the cropping position. For example, the following scene takes the left part of an image instead of the center:
+Without additional options, Narakeet will crop a large image around the center to cover the video size. If you want to show a different part of the image, specify the cropping position. For example, the following scene takes the left part of an image instead of the center:
 
 
 ```md

diff --git a/pronunciation/README.md b/pronunciation/README.md
@@ -1,17 +1,17 @@
 # Controlling pronunciation 
 
-This example shows how to control pronunciation and narration pauses in Video Puppet. 
+This example shows how to control pronunciation and narration pauses in Narakeet. 
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 
 
-You can use the standard markdown emphasis or strikethroughs to add emphasis or reduce importance for a specific sentence, and use stage directions such as `pause`, `voice-volume`, `voice-speed` or `voice-emphasis` to control the pronunciation. Check out the [Controlling pronunciation reference](https://videopuppet.com/docs/format/#controlling-pronunciation) for more information.
+You can use the standard markdown emphasis or strikethroughs to add emphasis or reduce importance for a specific sentence, and use stage directions such as `pause`, `voice-volume`, `voice-speed` or `voice-emphasis` to control the pronunciation. Check out the [Controlling pronunciation reference](https://www.narakeet.com/docs/format/#controlling-pronunciation) for more information.
 
 You can also use [SSML](https://en.wikipedia.org/wiki/Speech_Synthesis_Markup_Language) markup, and wrap the narration into `<speak></speak>` tags. For example, the following scene sets a moderate emphasis using SSML.
 

diff --git a/slide-css-theming/README.md b/slide-css-theming/README.md
@@ -1,12 +1,12 @@
-# Video Puppet slide CSS themes
+# Narakeet slide CSS themes
 
-This example shows how to create slide themes with CSS, in Video Puppet.
+This example shows how to create slide themes with CSS, in Narakeet.
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 
@@ -36,4 +36,4 @@ theme for this scene only
 ---
 ```
 
-For more information, check out the [theme format reference](http://videopuppet.com/docs/format#theme).
+For more information, check out the [theme format reference](http://www.narakeet.com/docs/format#theme).
diff --git a/slides/README.md b/slides/README.md
@@ -1,12 +1,12 @@
-# Video Puppet slides 
+# Narakeet slides 
 
-This example shows how to create slides with text, optionally adding them on top of images, in Video Puppet.
+This example shows how to create slides with text, optionally adding them on top of images, in Narakeet.
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 
@@ -18,7 +18,7 @@ Hi there!
 ```
 ~~~
 
-In case there is also an image or a video in the same scene, Video Puppet will show the slide over the scene, with a dark backdrop shadow to create contrast between the text and the background. This works well if the image or video behind the slide is mostly in light colours. 
+In case there is also an image or a video in the same scene, Narakeet will show the slide over the scene, with a dark backdrop shadow to create contrast between the text and the background. This works well if the image or video behind the slide is mostly in light colours. 
 
 
 For darker images or videos,  set the slide theme to `light` using the theme stage direction, to switch to lighter colors in the slide without a backdrop.
@@ -66,7 +66,7 @@ You can render rich text on slides by using markdown syntax, and marking the sli
 
 ## Syntax highlighting
 
-If you want to include code snippets as slides, Video Puppet will automatically support syntax highlighting as long as you specify the language after the opening code fence.
+If you want to include code snippets as slides, Narakeet will automatically support syntax highlighting as long as you specify the language after the opening code fence.
 
 ~~~
 ```css
@@ -79,7 +79,7 @@ If you want to include code snippets as slides, Video Puppet will automatically
 
 ## Controlling font size
 
-By default, Video Puppet sets the font for slides to relatively large (50px) to show clearly on smaller screens. For slides with a lot of text, you can set the size using the `(font-size)` stage direction. Set the value to an integer number of pixels.
+By default, Narakeet sets the font for slides to relatively large (50px) to show clearly on smaller screens. For slides with a lot of text, you can set the size using the `(font-size)` stage direction. Set the value to an integer number of pixels.
 
 ~~~
 (font-size: 20)

diff --git a/slides/script/source.md b/slides/script/source.md
@@ -1,4 +1,4 @@
-<!-- Video Puppet will show fenced code blocks as slides -->
+<!-- Narakeet will show fenced code blocks as slides -->
 
 ```
 Hi there!
@@ -59,7 +59,7 @@ Hi there!
 
 ---
 
-<!-- video puppet shows slides over images -->
+<!-- Narakeet shows slides over images -->
 
 ```
 Penguins!
@@ -75,7 +75,7 @@ Penguins!
 
 (theme: light)
 
-<!-- video puppet shows slides over videos -->
+<!-- Narakeet shows slides over videos -->
 
 ```
 Start counting!

diff --git a/subtitles/README.md b/subtitles/README.md
@@ -1,10 +1,10 @@
 # Adding subtitles
 
-This example shows how to add subtitles to Video Puppet scenes.
+This example shows how to add subtitles to Narakeet scenes.
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 
@@ -21,9 +21,9 @@ You can also explicitly set the subtitles for a scene using Markdown block quote
 
 ```md
 
-> Video Puppet will show this 
+> Narakeet will show this 
 
-Video Puppet will read this
+Narakeet will read this
 
 ```
 

diff --git a/transitions/README.md b/transitions/README.md
@@ -1,12 +1,12 @@
-# Video Puppet transitions example 
+# Narakeet transitions example 
 
 This example shows how to automatically apply transitions to video clips.
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 

diff --git a/vendor-audio/README.md b/vendor-audio/README.md
@@ -1,12 +1,12 @@
-# Video Puppet provided backgrounds 
+# Narakeet provided backgrounds 
 
-This example shows how to add a one of the standard background sounds to your video using Video Puppet. 
+This example shows how to add a one of the standard background sounds to your video using Narakeet. 
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 

diff --git a/vendor-audio/script/source.md b/vendor-audio/script/source.md
@@ -3,7 +3,7 @@ background: uplifting-2
 ---
 
 <!--
-use vendor instead of audio within background to load one of the audio files provided by video puppet directly. there is no need to attach these files into your project
+use vendor instead of audio within background to load one of the audio files provided by Narakeet directly. there is no need to attach these files into your project
 -->
 
 ```md

diff --git a/video-audio-sync/README.md b/video-audio-sync/README.md
@@ -1,12 +1,12 @@
-# Synchronising audio and video using Video Puppet  
+# Synchronising audio and video using Narakeet  
 
 This example shows how to automatically adjust a scene duration with a video and audio track. 
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 
@@ -26,4 +26,4 @@ Alternatively, you can provide a `video` stage direction, and specify the `sync`
 
 ## Supported synchronisation options
 
-Check out [Scene videos](https://videopuppet.com/docs/format/#videos) for more information on scene video sizing options
+Check out [Scene videos](https://www.narakeet.com/docs/format/#videos) for more information on scene video sizing options
diff --git a/video-segments/README.md b/video-segments/README.md
@@ -1,12 +1,12 @@
-# Extracting video segments using Video Puppet  
+# Extracting video segments using Narakeet  
 
 This example shows how to add parts of a video to a scene. This is useful in cases where you made a longer screen recording, but only want to use certain pieces of it in your video.
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 

diff --git a/video-sizing/README.md b/video-sizing/README.md
@@ -1,16 +1,16 @@
-# Video Puppet video sizing example 
+# Narakeet video sizing example 
 
-This example shows how to automatically resize video clips to fit the output format in Video Puppet. 
+This example shows how to automatically resize video clips to fit the output format in Narakeet. 
 
 Check out the outcome in [`result.mp4`](result.mp4).
 
 ## Try it out
 
-Upload the [`script`](script) directory to a Video Puppet project. The main script file is [`source.md`](script/source.md).
+Upload the [`script`](script) directory to a Narakeet project. The main script file is [`source.md`](script/source.md).
 
 ## How it works
 
-When adding a video to a scene, Video Puppet will automatically resize it to fit the target video format. You can control resizing by adding an option to the square brackets when setting the video. For example, to shrink and pad a larger video to fit the smaller target size, use the `contain` option:
+When adding a video to a scene, Narakeet will automatically resize it to fit the target video format. You can control resizing by adding an option to the square brackets when setting the video. For example, to shrink and pad a larger video to fit the smaller target size, use the `contain` option:
 
 ```md
 ![contain](birds.mp4)
@@ -26,5 +26,5 @@ Alternatively, you can provide a `video` stage direction in brackets, and add th
 
 ## Available sizing properties
 
-Check out [Scene videos](https://videopuppet.com/docs/format/#videos) for more information on scene video sizing options
+Check out [Scene videos](https://www.narakeet.com/docs/format/#videos) for more information on scene video sizing options
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,7 +3,7 @@ background: uplifting-2 @@
     ---
     <!--
-    use vendor instead of audio within background to load one of the audio files provided by video puppet directly. there is no need to attach these files into your project
+    use vendor instead of audio within background to load one of the audio files provided by Narakeet directly. there is no need to attach these files into your project
     -->
     ```md
@@ Expand Down @@