Commit Graph

210 Commits

Author SHA1 Message Date
Kevin Song 0965667807
ci: Use `dprint` to format documentation + TOML files ()
Adds Rust-based standardized markdown formatting and a CI step to catch unformatted files.
2022-01-20 11:32:09 +03:00
Matan Kushner 0da178780f
docs: break installation instructions to collapsable sections ()
As the number of supported systems and shells has grown, we've had to hand-pick what installation methods would be the "blessed" ones to show on our README. This change changes that to include all installation methods, but hides them each into OS and shell-specific collapsed sections, as is done by the excellent ajeetdsouza/zoxide.
2022-01-19 00:11:01 +03:00
Rashil Gandhi c335b4267b
feat: add support for cmd ()
* feat: add support for cmd

* add preprompt and precmd support

* add keymap support

* add info about minimum Clink version

* simplify escaping

* add handling for cmd custom commands

* add support for transient_prompt and transient_rprompt

* Revert 914057952508e81e20086fcb707ba2a0be85fdd3

This reverts commit "add support for transient_prompt and transient_rprompt"

* Apply suggestions from code review

* disable cmd shell custom commands

* any shell other than cmd can be used

* better error and correct script location

* move shell check in `map_no_escaping`
2022-01-09 23:47:53 -06:00
David Knaack 67cddb616b
fix(elvish): upgrade shell integration for v0.17 () 2021-12-30 09:49:55 +01:00
Matan Kushner 1cc83254d9
docs(i18n): add Indonesian and Italian docs () 2021-12-21 04:30:59 -05:00
Matan Kushner 6bdde634e9
docs: "Example:" → "With" 2021-10-29 13:40:28 -04:00
Matan Kushner 16f8c23614
docs: remove Open Collective from README.md 2021-10-22 00:58:51 +02:00
Matan Kushner ce168e3241
docs: add Brazilian Portuguese translations to the docs and website () 2021-08-26 16:44:58 -04:00
Andy Kipp 6271db4962
docs: Fix typo () 2021-07-19 20:23:49 +02:00
Jeremy Schlatter b1dcd5aecd
feat: add support for xonsh ()
* feat: add support for xonsh

* xonsh: add STARSHIP_SESSION_KEY

* xonsh: implement STARSHIP_SESSION_KEY in xonsh

* docs: mention tcsh, elvish, and nu in more places

* xonsh: change STARSHIP_SESSION_KEY implementation

See https://github.com/starship/starship/pull/2807#discussion_r667064149

* xonsh: fix jobs implementation

* xonsh: do not silently discard stderr from starship
2021-07-16 15:25:01 -04:00
Matan Kushner 57a523e4c2
docs(nu): specify how to get nushell config path () 2021-07-04 21:59:40 -04:00
David Knaack cea1a1ceb1
feat: add support for nu shell () 2021-07-04 15:32:58 -04:00
Thomas O'Donnell fb02a4523b
feat(install): Add help argument to install.sh () 2021-05-18 10:01:02 -04:00
Dario Vladović ea35359a09
docs: update install instructions ()
Use POSIX `sh`, mitigate possible timing attacks.
2021-04-08 19:42:45 +02:00
masa 9cf15b7840
docs: Add update documentation ()
Added documentation about upgrading starship itself via bash script.
2021-04-01 09:38:51 -05:00
Dario Vladović 4375517d9a
docs: format markdown ()
Remove trailing whitespace and extra newlines.
2021-03-24 21:44:52 +01:00
Vivek Malneedi 69b9bf72c3
fix(tcsh): remove quotes and escape backticks ()
* feat: add support for tcsh

* add tcsh to install.sh install message

* list tcsh in bug_report.rs and main.rs

* quote starship path

Co-authored-by: David Knaack <davidkna@users.noreply.github.com>

* fix job count

* add tcsh support to shell module

* fix STARSHIP_START_TIME undefined error

* preserve existing user precmd and postcmd, remove jobs support

* remove unnecessary parentheses

* minor script improvement

* removes parens from install script message

* Update docs/config/README.md

Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>

* fix(Tcsh): remove unecessary quotes

Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>
2021-03-12 16:27:04 +01:00
Vivek Malneedi d21400a478
feat: add support for tcsh ()
* feat: add support for tcsh

* add tcsh to install.sh install message

* list tcsh in bug_report.rs and main.rs

* quote starship path

Co-authored-by: David Knaack <davidkna@users.noreply.github.com>

* fix job count

* add tcsh support to shell module

* fix STARSHIP_START_TIME undefined error

* preserve existing user precmd and postcmd, remove jobs support

* remove unnecessary parentheses

* minor script improvement

* removes parens from install script message

* Update docs/config/README.md

Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>

Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>
2021-02-27 19:55:27 +01:00
Matan Kushner e7246cee82
chore: update Discord link to use vanity URL 2021-02-08 14:54:28 -05:00
David Knaack 22dc8b842e
feat: add support for elvish shell ()
* feat: add support for elvish shell

* improve doc

* elvish 0.15 is out

* fix example init

* update systax for 0.15 stable

* udpate second init example too

* remove warning from swift module

* add warning to status module docs

* prefix elvish version with v
2021-02-02 12:59:55 +01:00
Matan Kushner 6afd9ecaf3
docs(i18n): add Vietnamese doc translations 2021-01-26 17:25:25 -05:00
David Knaack 0faa05628e
docs: highlight powershell in vuepress () 2021-01-14 15:48:06 -05:00
Dani d009db528d
docs(installation): add advanced installation ()
Adds an "Advanced Installation" page to the documentation website.
2021-01-05 17:05:03 -06:00
Matan Kushner f9ac1eacad
docs(i18n): add French and Spanish doc translations () 2020-11-29 14:33:38 -05:00
David Knaack 368945f5db
docs(pwsh/init): various fixes for init doc () 2020-11-03 18:52:46 +01:00
Matouš Dzivjak 09f3b2a8dd
fix(docs): Fix Explore The Starship link in guide ()
Fix Explore the Starship docs link in guide 
that redirected to homepage instead of docs.

Fixes: https://github.com/starship/starship/issues/1542
2020-08-03 12:47:25 -05:00
Brady Joslin aa8ec60701
docs: fix broken contribute link on starship.rs () 2020-06-26 16:59:41 -04:00
Matan Kushner fbcfb640a5
docs: instruct users to install a nerd-font () 2020-06-24 09:05:01 +02:00
Federico Jaramillo Martínez 7aa9c8fab0
docs: Fix broken installation link anchor on README ()
* Fix Installation link anchor on README

* Use fake anchor for Installation
2020-04-20 12:43:24 -05:00
Matan Kushner e94d5439ce
docs: add Open Collective to README
Closes 
2020-04-06 13:19:47 -04:00
Matan Kushner dc96df510a
docs: Add twitter badge to README 2020-02-13 15:49:40 -05:00
Matan Kushner b8313f81ed
docs: Update the link of the contributors badge 2020-02-12 21:17:58 -05:00
Matan Kushner d901e262d0
docs: rework the project README.md () 2020-02-12 21:13:53 -05:00
Matan Kushner a07a97de01
docs: remove icons from badges 2020-02-11 18:28:19 -05:00
Matan Kushner d1298b486a
docs: use flat-square badges in README.md 2020-02-11 18:21:56 -05:00
Andrew Prokhorenkov 273a937505 feat: Add an Elm module ()
Former-commit-id: d42137309da457a438b554601f0734db963a193e
2020-02-05 22:57:04 -05:00
Matan Kushner af6a9e2e56 docs: Update all-contributors
Former-commit-id: 3631822be4c366b13d808292f924ea15787e09e8
2020-02-05 00:16:26 -05:00
allcontributors[bot] bf95f79b9f
docs: add chirsz-ever as a contributor () 2020-02-05 00:15:13 -05:00
Matan Kushner 2b53490e9e
docs(i18n): Add Simplified Chinese docs to the website and README.md () 2020-02-04 23:57:11 -05:00
allcontributors[bot] dd73e6dc04
docs: add youssefhabri as a contributor () 2020-02-04 18:29:15 -05:00
Matan Kushner 6a762e83d1
docs: small doc touchups 2020-02-04 18:28:11 -05:00
Youssef Habri f665df226c
feat: Add Crystal version module () 2020-02-04 18:27:06 -05:00
allcontributors[bot] 5342dcc658 docs: add m0nhawk as a contributor ()
* docs: update README.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

* docs: update README.md [skip ci]

* docs: update .all-contributorsrc [skip ci]
2020-01-25 16:35:43 -06:00
Andrew Prokhorenkov 6f2c9fb397 feat: add Haskell Stack support ()
Add a Haskell Stack module when a stack.yaml file is detected
2020-01-25 00:48:39 -06:00
Matan Kushner 88b9b0ffe2
docs(i18n): Add German docs to the website and README.md () 2020-01-21 15:49:49 -05:00
allcontributors[bot] bf4705f914 docs: add pjbull as a contributor () 2020-01-21 11:18:45 -05:00
allcontributors[bot] 57427b5d7a docs: add ivanovart as a contributor ()
* docs: update README.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

Co-authored-by: Matan Kushner <hello@matchai.dev>
2020-01-20 13:36:32 -05:00
allcontributors[bot] 5a988515a0 docs: add filalex77 as a contributor () 2020-01-20 13:33:55 -05:00
allcontributors[bot] 98049e2877 docs: add gkeep as a contributor () 2020-01-20 13:32:04 -05:00
Matan Kushner bfbe330549
docs(i18n): Add Russian docs to the website and README.md 2020-01-20 13:06:34 -05:00