Markdown Video

Narakeet makes it easy to script videos using plain text (Markdown) files.

  • Common tasks

This plugin allows you to use the OSF's Modualar File Renderer or the MFR to embed video or other files into your markdown assuming your page has mfr.js and mfr.css loaded. @osf(kuvg9) is interpreted as. Markdown supports HTML, so if you need to, say, embed a YouTube video, you can just copy and paste the embed code from them, drop it into a Markdown document, and you should be good to go. With YouTube specifically, there are other options. But in general, you don’t need to do anything special to embed third-party media in Markdown. Videos are responsively displayed at 100% of their container’s width (with height automatically determined based on a 16x9 aspect ratio). You can change this behavior by adding attributes to the Markdown code where you reference the video. You can specify an alternate percentage for the video’s width or an alternate fixed width and height.

Markdown video file
Into this...

New to Narakeet? Do this in the first 5 minutes!

Note: If you are not familiar with editing plain text files, create videos from PowerPoint presentations instead.

Download this example script file. Narakeet created the video below based on that script. Tweak the file then create a new video by uploading the modified file.

Next, create a new script, and upload it along with images or video clips, to create a new video. Make sure to name the file so it has the .txt, .md or .mkd file extension for best results.

Common tasks

Here is how to perform some common tasks as you start experimenting with Narakeet:

Add videos or images

You can link images or videos by using the standard Markdown syntax. Then just upload those files along with your script.

Add voice to video

Narakeet automatically generates narration from the text in the markdown file. The following scene will include an image, and automatically generated voice narration:

Set the voice-over language

Narakeet supports adding voice to video in many languages. To change the language, just change the active voice. Check out the available voices for an up-to-date list of supported languages and voices. Use the voice header to set the voice for the whole video. Use the voice stage direction to set it for a particular scene or a paragraph.

Control pronunciation and add pauses in the narration

Add a pause stage direction between the paragraphs. The instruction should be in brackets, followed by a colon (:) and a number of seconds you want to wait. It’s important to add this into a separate paragraph, so there needs to be a blank line between the instruction and the rest of the text. For example, to add a pause of 3 seconds between two sentences, add this to speaker notes:

Check out the Narration format reference for more information.

Use your own voice over video

Instead of automatically generated narration, you can add your own audio files, with recorded voice, music or something else to play during a scene. To do so, just add (audio: file) in a separate paragraph. For example, this scene will show an image from london.jpg and play the audio from london-audio.mp3:

Change the voice for a particular paragraph

Markdown Video

Add a voice stage direction between the paragraphs in your speaker notes to set the voice for the following text. The instruction should be in brackets, followed by a colon (:) and a number of seconds you want to wait. It’s important to add this into a separate paragraph, so there needs to be a blank line between the instruction and the rest of the text. For example:

Check out the Narration format reference for more information.

To preview the voices, check out the available voices page.

Change the voice for the whole video

You can add global video properties in the script header, starting the script file with a scene separator (---). The following script file sets the global voice for all scenes:

Markdown

Set the video size

Unless you request otherwise, Narakeet creates videos in 16x9 aspect ratio, with the 720p resolution that is useful for most online services today. You can change the video size easily by using the size header.

Markdown

Crop, resize and position images

When you add images or clips to your video, they will be automatically resized and cropped according to the target video size. You can control many aspects of this, such as covering or containing the image, centering it or aligning with a particular edge. Check out the image format reference guide.

Embed video in github readme

Add more scenes

To add more scenes, use three or more dashes (---) as a separator. The following script file creates two scenes:

Add text on top of images or videos

Narakeet can put text on top of images or videos, both to caption videos and to create textual slides (such as headings, bullet point lists or even show syntax-highlighted code snippets).

For more information on creating subtitles or captions, check out the subtitles format reference.

For information on creating text slides, check out the text slides format reference.

More examples

Markdown Video Embed

Check out these ready-made projects to see key features in action

  • Screencast: source, video
  • Coding tutorial: source, video
  • Quick announcement: source, video

More information

For a detailed list of things you can achieve with Narakeet scripts, check out the format reference.

Markdown Video

Also, check the examples on Github for ready-made demonstration scripts for key features.