Skip to content

Commit cf93cfb

Browse files
committed
Merge pull request #2 from olets/release-next
v4 docs pt 1
2 parents bfb5edf + c9f5ae4 commit cf93cfb

File tree

9 files changed

+5
-39
lines changed

9 files changed

+5
-39
lines changed

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,7 @@
22

33
Documentation for [Git Prompt Kit](https://github.com/olets/git-prompt-kit)
44

5-
Read the documentation at <https://next.git-prompt-kit.olets.dev/>.
6-
7-
&nbsp;
8-
9-
> This is the WIP branch for the next major version. **It may be force pushed.**
10-
11-
&nbsp;
5+
Read the documentation at <https://git-prompt-kit.olets.dev/>.
126

137
## Requirements
148

docs/.vuepress/config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,18 +139,18 @@ export default defineUserConfig({
139139
navbar: [
140140
{
141141
text: "Changelog",
142-
link: "https://github.com/olets/git-prompt-kit/blob/v4/CHANGELOG.md",
142+
link: "https://github.com/olets/git-prompt-kit/blob/main/CHANGELOG.md",
143143
target: "_self",
144144
},
145145
{
146146
text: "License",
147-
link: "https://github.com/olets/git-prompt-kit/blob/v4/LICENSE",
147+
link: "https://github.com/olets/git-prompt-kit/blob/main/LICENSE",
148148
target: "_self",
149149
},
150150
// Manual instead of with defaultTheme's `repo` so that we can specify the `target`
151151
{
152152
text: "GitHub",
153-
link: "https://github.com/olets/git-prompt-kit/tree/v4",
153+
link: "https://github.com/olets/git-prompt-kit",
154154
target: "_self",
155155
},
156156
{

docs/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
# Git Prompt Kit ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/olets/git-prompt-kit?include_prereleases&label=pre-release) ![GitHub commits since latest release (by SemVer including pre-releases)](https://img.shields.io/github/commits-since/olets/git-prompt-kit/latest?include_prereleases)
2-
3-
:::warning
4-
These are the docs for v4, which is not yet released.
5-
:::
1+
# Git Prompt Kit ![GitHub release (latest by date)](https://img.shields.io/github/v/release/olets/git-prompt-kit) ![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/olets/git-prompt-kit/latest)
62

73
![splash card: the text 'GIT PROMPT KIT' as green neon lettering](/images/git-prompt-kit.png)
84

docs/components.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Components
22

3-
:::warning
4-
These are the docs for v4, which is not yet released.
5-
:::
6-
73
To use Git Prompt Kit's components in a custom prompt, load Git Prompt Kit and then refer to any of its components.
84

95
For example, to create the minimal prompt `<current working directory> [<Git HEAD> ]% `:

docs/demo.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Interactive Demo & Configurator
22

3-
:::warning
4-
These are the docs for v4, which is not yet released.
5-
:::
6-
73
:::tip
84
Another convenient way to experiment with Git Prompt Kit is to install (even temporarily!) [Hometown](https://github.com/olets/hometown-prompt), a Git Prompt Kit-powered zsh prompt.
95
:::

docs/installation.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Installation
22

3-
:::warning
4-
These are the docs for v4, which is not yet released.
5-
:::
6-
73
Shell plugin manager is the recommended installation method.
84

95
## With a shell plugin manager

docs/integrations.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Integrations
22

3-
:::warning
4-
These are the docs for v4, which is not yet released.
5-
:::
6-
73
[[toc]]
84

95
### Spaceship

docs/options.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Options
22

3-
:::warning
4-
These are the docs for v4, which is not yet released.
5-
:::
6-
73
Set variables in `.zshrc`. For example, to only show the user if _not_ `me`, only show the host if _not_ `my-computer` or `my-other-computer`, and use symbols to distinguish between branches and commits:
84

95
```shell

docs/recipes.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Recipes
22

3-
:::warning
4-
These are the docs for v4, which is not yet released.
5-
:::
6-
73
The following are based on popular Git-aware prompts. These have not been thoroughly battle tested — they are not "supported official Git Prompt Kit themes" but rather starting points for those new to customizing the zsh prompt.
84

95
:::tip

0 commit comments

Comments
 (0)