1
0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-13 14:33:01 +00:00
Commit Graph

28 Commits

Author SHA1 Message Date
David Knaack
7485c90c9f
feat(docs): move to vitepress (#5785)
* feat(docs): move to vitepress

* change up hero styles to match existing site

* A bit more style tweaking

* Replace stylus with plain CSS

* improve unicode-range value for nerdfont

---------

Co-authored-by: Matan Kushner <hello@matchai.dev>
2024-03-03 17:55:30 +01:00
Andre Wiggins
adc1b2503e
docs(install): Add FAQ entry for installing Starship without sudo (#5648)
Add FAQ entry for installing Starship without sudo

Per [the comment](https://github.com/starship/starship/issues/5190#issuecomment-1553411366) in #5190, I've added an FAQ entry that includes an example script to install Starship without requiring `sudo`.
2023-12-30 17:32:11 +01:00
Zhizhen He
f6c9fd5348
docs: fix typos (#4889) 2023-02-07 12:52:41 +01:00
Kid
7cdc230100
fix(docs): fix and cleanup VuePress config (#3738)
* Use relative links

* Remove migrating link

* Fix zh-* config

* Adjust how sidebar is generated

* Enable evergreen

* Format

* Update docs/.vuepress/config.js

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

Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2022-03-11 14:48:44 -06:00
Matan Kushner
48f1f756f8
fix: use shell-compatible curl install (#3691) 2022-03-08 15:47:54 -05:00
Kevin Song
0965667807
ci: Use dprint to format documentation + TOML files (#3426)
Adds Rust-based standardized markdown formatting and a CI step to catch unformatted files.
2022-01-20 11:32:09 +03:00
Tobias
20a78c1153
docs(faq): for uninstalling, change which to command -v (#3394)
* Changed 'which' to 'command -v' which is more general, and available on more systems

* docs: for uninstalling, change which to command -v
2022-01-07 21:53:22 +01:00
Martin Dixon
fffc7561f6
fix: typo in FAQ page (#3347) 2021-12-23 16:03:51 +01:00
Thomas O'Donnell
73277d37c6
docs(faq): Add debugging and timeout Q&As (#3190)
* docs(faq): Add debugging docs to the FAQ.

Have added some basic docs on debugging to the FAQ.

* docs(faq): Add question about commands timing out

Have added a question and answer about commands timing out and what to
do.

* Update docs/faq/README.md

Co-authored-by: Matan Kushner <hello@matchai.dev>

Co-authored-by: Matan Kushner <hello@matchai.dev>
2021-10-30 11:24:17 +02:00
Dario Vladović
ea35359a09
docs: update install instructions (#2553)
Use POSIX `sh`, mitigate possible timing attacks.
2021-04-08 19:42:45 +02:00
Dario Vladović
d79f6f365d
docs(faq): change uninstall snippet to use sh (#2552) 2021-04-05 16:48:24 +02:00
Julia
4af29d6355
docs(faq): make uninstall instructions shell-indepedent (#2483)
Closes #2484.
2021-04-01 09:42:07 -05:00
Colin Marquardt
30910cb4ac
fix(docs): "Command Duration" section link target (#2416) 2021-03-12 15:31:26 +01:00
Thomas O'Donnell
7fe96b1f3e
docs(faq): Add starship explain to FAQ (#2387) 2021-02-27 22:24:03 +01:00
Matan Kushner
b150e85e8d
docs: add 'autocomplete' keyword to FAQ 2020-12-14 12:54:30 -05:00
Matan Kushner
47492d686b
docs(FAQ): add FAQ about shell completions 2020-10-05 14:26:22 -04:00
Jan Katins
17e8115f16
docs: Improvements in docs for custom modules (#1615)
* docs: Clarify that commands will be passed in on stdin

* docs: Clearer instruction how to include individual custom modules

* docs: Include link to #1252 in docs for custom modules

That issue is used to share custom modules.

* docs: Remove reference to prompt_order

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

Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>
2020-09-01 19:07:12 +02:00
Matan Kushner
c4fa87a213
docs: add uninstallation instructions to FAQ (#1474) 2020-07-18 16:57:12 -04:00
Matan Kushner
13597faef3
docs: update font in FAQ from Fira Code → FiraCode Nerd Font 2020-07-06 19:00:42 -04:00
Matan Kushner
f102356b1e
docs: replace powerline requirement with nerd font requirement 2020-07-06 17:19:28 -04:00
Matan Kushner
2cc2469cfe
docs: update dotfile link in FAQ 2020-06-24 12:21:01 -04:00
Kevin Song
2a57c69459
docs: Add FAQ entry on missing symbols (#1307)
Adds FAQ entry for what to do if powerline/emoji symbols are missing.

Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>
2020-06-15 18:12:43 -05:00
Matan Kushner
90dd4eebd6
docs: fix example Starship implementation in bash 2020-05-19 20:26:44 -04:00
Daniel Lo Nigro
5b8f869e5e
docs: Add details about musl build to readme (#997)
* Add details about musl build to readme

* Move details to FAQ
2020-04-10 19:58:10 +02:00
Thomas O'Donnell
780816926f docs: Correct a typo in the FAQs (#732)
Have fixed a minor typo in the FAQs to use the `--help` flag rather than
the `--version` flag.
2019-12-13 15:26:23 -05:00
Matan Kushner
33df8ac063
docs: Fix typo in FAQ 2019-12-02 13:35:10 -05:00
Matan Kushner
d1988fce8c
docs: Fix heading hierarchy in FAQ 2019-12-02 13:13:11 -05:00
Matan Kushner
48804c048d
docs: Add an FAQ page to website (#583) 2019-12-01 18:47:19 -05:00