Skip to content

Commit

Permalink
Add category backlinks (nushell#1312)
Browse files Browse the repository at this point in the history
* Add category backlinks

* Command updates for next version
  • Loading branch information
texastoland committed Apr 3, 2024
1 parent ec5b26d commit cec6f09
Show file tree
Hide file tree
Showing 543 changed files with 2,111 additions and 1,951 deletions.
2 changes: 1 addition & 1 deletion commands/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To see all commands from inside Nushell, run [`help commands`](/commands/docs/he
<th>Feature</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.categories }}</td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.feature }}</td>
Expand Down
2 changes: 1 addition & 1 deletion commands/categories/bits.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/bytes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/conversions.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/dataframe.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/dataframe_or_lazyframe.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/date.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/expression.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/generators.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/hash.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/lazyframe.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/math.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/misc.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/path.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/random.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/removed.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/shells.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/strings.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/system.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion commands/categories/viewers.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<th>Description</th>
</tr>
<tr v-for="command in commands">
<td><a :href="command.path">{{ command.title }}</a></td>
<td><a :href="$withBase(command.path)">{{ command.title }}</a></td>
<td style="white-space: pre-wrap;">{{ command.frontmatter.usage }}</td>
</tr>
</table>
6 changes: 3 additions & 3 deletions commands/docs/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: alias
categories: |
core
version: 0.91.0
version: 0.92.0
core: |
Alias a command (with optional flags) to a new name.
usage: |
Expand All @@ -11,9 +11,9 @@ feature: default
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for core
# `alias` for [core](/commands/categories/core.md)

<div class='command-title'>{{ $frontmatter.core }}</div>
<div class='command-title'>Alias a command (with optional flags) to a new name.</div>

## Signature

Expand Down
6 changes: 3 additions & 3 deletions commands/docs/all.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: all
categories: |
filters
version: 0.91.0
version: 0.92.0
filters: |
Test if every element of the input fulfills a predicate expression.
usage: |
Expand All @@ -11,9 +11,9 @@ feature: default
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for filters
# `all` for [filters](/commands/categories/filters.md)

<div class='command-title'>{{ $frontmatter.filters }}</div>
<div class='command-title'>Test if every element of the input fulfills a predicate expression.</div>

## Signature

Expand Down
6 changes: 3 additions & 3 deletions commands/docs/ansi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: ansi
categories: |
platform
version: 0.91.0
version: 0.92.0
platform: |
Output ANSI codes to change color and style of text.
usage: |
Expand All @@ -11,9 +11,9 @@ feature: default
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for platform
# `ansi` for [platform](/commands/categories/platform.md)

<div class='command-title'>{{ $frontmatter.platform }}</div>
<div class='command-title'>Output ANSI codes to change color and style of text.</div>

## Signature

Expand Down
12 changes: 4 additions & 8 deletions commands/docs/ansi_gradient.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,19 @@
title: ansi gradient
categories: |
platform
version: 0.91.0
version: 0.92.0
platform: |
Add a color gradient (using ANSI color codes) to the given string.
usage: |
Add a color gradient (using ANSI color codes) to the given string.
feature: extra
feature: default
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for platform
# `ansi gradient` for [platform](/commands/categories/platform.md)

<div class='command-title'>{{ $frontmatter.platform }}</div>
<div class='command-title'>Add a color gradient (using ANSI color codes) to the given string.</div>


::: warning
Command `ansi gradient` was not included in the official binaries by default, you have to build it with `--features=extra` flag
:::
## Signature

```> ansi gradient {flags} ...rest```
Expand Down
Loading

0 comments on commit cec6f09

Please sign in to comment.