Skip to content

Configuration

Options

name default
title "bash"
buttons "macos" "macos", "windows"
prompt_literal_start ["$"]
include_assets false
assets_override_css null path to custom css file
assets_override_js null path to custom js file
animate true false renders instantly, without animation

Global configuration

Set defaults for every block in mkdocs.yml:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
plugins:
  - termynal:
      title: bash
      buttons: macos
      prompt_literal_start:
        - "$"
      include_assets: false
      assets_override_css: null
      assets_override_js: null
      animate: true

Per-block overrides

You can override configurations for each block. If you set a part of the settings, the other part will be set to the default value from mkdocs.yml.

Custom prompt and buttons

<!-- termynal: {"prompt_literal_start": ["$", ">>>", "PS >"], title: powershell, buttons: windows} -->

1
2
3
4
```
PS > python
>>> import json
```
pythonimport json

Disabling animation

Set animate: false to render a block instantly, without the typing animation:

pip install termynalInstalled