https://github.com/nekomeowww/obsidian-asciinema-player

This is a Obsidian plugin which supports embedding asciicast files into Markdown files
https://github.com/nekomeowww/obsidian-asciinema-player

asciinema-player obsidian-plugin

Last synced: 8 days ago
JSON representation

This is a Obsidian plugin which supports embedding asciicast files into Markdown files

• Host: GitHub
• URL: https://github.com/nekomeowww/obsidian-asciinema-player
• Owner: nekomeowww
• Created: 2021-10-13T08:58:31.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-04T10:24:49.000Z (about 3 years ago)
• Last Synced: 2024-12-06T20:27:14.866Z (16 days ago)
• Topics: asciinema-player, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 396 KB
• Stars: 7
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
English | [简体中文](https://github.com/nekomeowww/obsidian-asciinema-player/blob/master/doc/README-zhcn.md)

## Obsidian `asciinema-player` Plugin

This is a [Obsidian](https://obsidian.md) plugin which supports embedding [asciicast](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md) files into your Markdown files.

For more details about [asciicast](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md), you may want to visit [asciinema recorder](https://github.com/asciinema/asciinema) and [asciinema.org](https://asciinema.org).

## Installation

### From Obsidian Community Plugin

**Attention: Not published to Obsidian Community Plugin yet**

### Manually

1. Clone

```shell

$ git clone https://github.com/nekomeowww/obsidian-asciinema-player /.obsidian/plugins

```

2. Build from source code

```shell

$ pnpm i && pnpm build

```

3. Active plugin in **Obsidian Community Plugin** tab

####

## Usage

### Install `asciinema recorder`

1. By using optional package manager `brew` on macOS

```shell

$ brew install asciinema

```

2. By using `pip3`

```shell

$ sudo pip3 install asciinema

```

### Create `asciicast` file

```shell

$ asciinema rec 

```

Such as

```shell

$ asciinema rec demo.cast

```

Insert the file into your Obsidian Vault.

### Markdown markup syntax

```markdown

![](asciinema:)

```