From c49e54b16bad5deb4f0b0ffc026b06e0c4a1996c Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Sat, 28 Sep 2019 20:20:18 +0900 Subject: [PATCH] docs: Add extra newlines around custom containers --- docs/advanced-config/README.md | 2 ++ docs/config/README.md | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/docs/advanced-config/README.md b/docs/advanced-config/README.md index 346b8e82..a5a2dda3 100644 --- a/docs/advanced-config/README.md +++ b/docs/advanced-config/README.md @@ -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 diff --git a/docs/config/README.md b/docs/config/README.md index 81bed205..e968d156 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -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