Termynal
A lightweight and modern animated terminal window. Built for mkdocs.
Installation
pip install termynalInstalled
Usage
Use <!-- termynal -->
before code block
progress
progress, prompt ---> 100%
command
command, start with $
. You can change it with prompt_literal_start
option.
multiline command
comment
comment, start with #
output
tool's help looks like this:
poetry --help
Description:
Lists commands.
Usage:
list [options] [--] [<namespace>]
Arguments:
namespace The namespace name
Options:
-h, --help Display help for the given command.
When no command is given display help
for the list command.
-q, --quiet Do not output any message.
-V, --version Display this application version.
--ansi Force ANSI output.
--no-ansi Disable ANSI output.
-n, --no-interaction Do not ask any interactive question.
--no-plugins Disables plugins.
--no-cache Disables Poetry source caches.
-C, --directory=DIRECTORY The working directory for the Poetry
command (defaults to the current
working directory).
-v|vv|vvv, --verbose Increase the verbosity of messages:
1 for normal output,
2 for more verbose output and
3 for debug.
Help:
The list command lists all commands:
poetry list
You can also display the commands for a specific namespace:
poetry list test
Description:
Lists commands.
Usage:
list [options] [--] [<namespace>]
Arguments:
namespace The namespace name
Options:
-h, --help Display help for the given command.
When no command is given display help
for the list command.
-q, --quiet Do not output any message.
-V, --version Display this application version.
--ansi Force ANSI output.
--no-ansi Disable ANSI output.
-n, --no-interaction Do not ask any interactive question.
--no-plugins Disables plugins.
--no-cache Disables Poetry source caches.
-C, --directory=DIRECTORY The working directory for the Poetry
command (defaults to the current
working directory).
-v|vv|vvv, --verbose Increase the verbosity of messages:
1 for normal output,
2 for more verbose output and
3 for debug.
Help:
The list command lists all commands:
poetry list
You can also display the commands for a specific namespace:
poetry list test
Mkdocs integration
Declare the plugin:
Optionally, pass options to the processor:
This config allows you to use another prompt:
Credits
Thanks ines