docs: add gif for transient prompt

This commit is contained in:
Shawn Wildermuth 2021-10-19 13:39:20 -04:00 committed by GitHub
parent 410fb82e13
commit 84bddd4b99
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 17 additions and 0 deletions

View file

@ -76,6 +76,14 @@ Import/invoke Oh My Posh in your `$PROFILE` and add the following line below:
Enable-PoshTooltips
```
For example:
```pwsh
# $PROFILE
oh-my-posh --init --shell pwsh --config ~\wildertheme.json | Invoke-Expression
Enable-PoshTooltips
```
Restart your shell or reload your `$PROFILE` using `. $PROFILE` for the changes to take effect.
</TabItem>
@ -102,6 +110,15 @@ Transient prompt, when enabled, replaces the prompt with a simpler one to allow
You can use go [text/template][go-text-template] templates extended with [sprig][sprig] to enrich the text.
Environment variables are available, just like the [`console_title_template`][console-title] functionality.
Typically, your prompt will simply leave the prompt on the screen when you execute a command (or press enter) like so:
![Before Transient](/img/transient-before.gif)
By enabling Transient Prompt, you can replace the prompt with some other content for a cleaner console as shown here:
![After Transient](/img/transient-after.gif)
### Configuration
You need to extend or create a custom theme with your transient prompt. For example:

BIN
docs/static/img/transient-after.gif vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

BIN
docs/static/img/transient-before.gif vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB