Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-28 07:46:28 +00:00
Code Issues Releases Activity

docs: Add extra newlines around custom containers

Browse Source
This commit is contained in:
Matan Kushner 2019-09-28 20:20:18 +09:00
parent a89f613c85
commit c49e54b16b
No known key found for this signature in database
GPG Key ID: 4B98C3A8949CA8A4
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/advanced-config/README.md
View File

@ -5,7 +5,9 @@ While Starship is a versatile shell, sometimes you need to do more than edit
advanced configuration techniques used in starship.
::: warning
The configurations in this section are subject to change in future releases of Starship.
:::
## Custom pre-prompt and pre-execution Commands in Bash

6
docs/config/README.md
View File

@ -1,8 +1,10 @@
# Configuration
::: tip
🔥 Configuration is currently being worked on.
Many new configuration options will be available in coming releases.
:::
To get started configuring starship, create the following file: `~/.config/starship.toml`.
@ -241,8 +243,10 @@ The module will be shown only if the command took longer than two seconds, or
the `min_time` config value, if it exists.
::: warning Do not hook the DEBUG trap in Bash
If you are running Starship in `bash`, do not hook the `DEBUG` trap after running
`eval $(starship init $0)`, or this module **will** break.
:::
Bash users who need preexec-like functionality can use
@ -747,8 +751,10 @@ The `time` module shows the current **local** time.
The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip
This module is disabled by default.
To enable it, set `disabled` to `false` in your configuration file.
:::
### Options