shortcode-asciinema | FixIt

Demo

Installation Theme#CLI | FixIt

Requirements

Applicable to all Hugo themes.

Install Component

The installation method is the same as installing a theme. There are several ways to install, choose one, Here are two mainstream ways.

Install as Hugo Module

First make sure that your project itself is a Hugo module.

Then add this theme component to your hugo.toml configuration file:

[module]
  [[module.imports]]
    path = "github.com/hugo-fixit/FixIt"
  [[module.imports]]
    path = "github.com/hugo-fixit/shortcode-asciinema"

On the first start of Hugo it will download the required files.

To update to the latest version of the module run:

hugo mod get -u
hugo mod tidy

Install as Git Submodule

Clone FixIt and this git repository into your theme folder and add it as submodules of your website directory.

git submodule add https://github.com/hugo-fixit/FixIt.git themes/FixIt
git submodule add https://github.com/hugo-fixit/shortcode-asciinema.git themes/shortcode-asciinema

Next edit hugo.toml of your project and add this theme component to your themes:

theme = ["FixIt", "shortcode-asciinema"]

Record Terminal

You can use the asciinema command to record the terminal and upload it to asciinema.org.

asciinema rec demo.cast
# press <ctrl-d> or type "exit" when you're done
asciinema upload demo.cast

Use Shortcode

Here is an example of usage:

{{< asciinema-embed 697494 >}}

The rendering effect is as follows:

References

• Develop Theme Components | FixIt
• How to Develop a Hugo Theme Component | FixIt