1
0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-06-22 01:52:24 +00:00

docs: Use Algolia DocSearch for docs

This commit is contained in:
Matan Kushner 2020-02-07 12:36:23 -05:00
parent bc600e4321
commit 91008ba5f2
No known key found for this signature in database
GPG Key ID: 4B98C3A8949CA8A4
2 changed files with 10 additions and 5 deletions

View File

@ -29,7 +29,7 @@ module.exports = {
lang: "zh-TW", lang: "zh-TW",
title: "Starship", title: "Starship",
description: "The cross-shell prompt for astronauts" description: "The cross-shell prompt for astronauts"
}, }
}, },
// prettier-ignore // prettier-ignore
head: [ head: [
@ -56,6 +56,11 @@ module.exports = {
docsDir: "docs", docsDir: "docs",
// defaults to false, set to true to enable // defaults to false, set to true to enable
editLinks: true, editLinks: true,
// enables Algolia DocSearch
algolia: {
apiKey: "107bdc34b894d5d1dd0824b420184c2d",
indexName: "starship"
},
locales: { locales: {
"/": { "/": {
// text for the language dropdown // text for the language dropdown
@ -168,7 +173,7 @@ module.exports = {
["/zh-CN/faq/", "常见问题"], ["/zh-CN/faq/", "常见问题"],
["/zh-CN/presets/", "社区配置分享"] ["/zh-CN/presets/", "社区配置分享"]
] ]
}, }
} }
}, },
plugins: [ plugins: [

View File

@ -9,7 +9,7 @@ Many new configuration options will be available in coming releases.
To get started configuring starship, create the following file: `~/.config/starship.toml`. To get started configuring starship, create the following file: `~/.config/starship.toml`.
```shell ```sh
$ mkdir -p ~/.config && touch ~/.config/starship.toml $ mkdir -p ~/.config && touch ~/.config/starship.toml
``` ```
@ -29,7 +29,7 @@ disabled = true
``` ```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable:
```shell ```sh
export STARSHIP_CONFIG=~/.starship export STARSHIP_CONFIG=~/.starship
``` ```
@ -408,7 +408,7 @@ heuristic = false
## Elm ## Elm
The `elm` module shows the currently installed version of Elm version. The `elm` module shows the currently installed version of Elm.
The module will be shown if any of the following conditions are met: The module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file - The current directory contains a `elm.json` file