From 91008ba5f23847427d846ac84e91e7c74b44c093 Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Fri, 7 Feb 2020 12:36:23 -0500 Subject: [PATCH] docs: Use Algolia DocSearch for docs --- docs/.vuepress/config.js | 9 +++++++-- docs/config/README.md | 6 +++--- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 336683c4..5fef73af 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -29,7 +29,7 @@ module.exports = { lang: "zh-TW", title: "Starship", description: "The cross-shell prompt for astronauts" - }, + } }, // prettier-ignore head: [ @@ -56,6 +56,11 @@ module.exports = { docsDir: "docs", // defaults to false, set to true to enable editLinks: true, + // enables Algolia DocSearch + algolia: { + apiKey: "107bdc34b894d5d1dd0824b420184c2d", + indexName: "starship" + }, locales: { "/": { // text for the language dropdown @@ -168,7 +173,7 @@ module.exports = { ["/zh-CN/faq/", "常见问题"], ["/zh-CN/presets/", "社区配置分享"] ] - }, + } } }, plugins: [ diff --git a/docs/config/README.md b/docs/config/README.md index 6ef411b2..83da25d2 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -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`. -```shell +```sh $ 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: -```shell +```sh export STARSHIP_CONFIG=~/.starship ``` @@ -408,7 +408,7 @@ heuristic = false ## 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 current directory contains a `elm.json` file