Skip to content

Commit

Permalink
docs(wiki): fix inconsistencies
Browse files Browse the repository at this point in the history
  • Loading branch information
vyfor committed Jan 10, 2025
1 parent f1899cf commit efbfa36
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 24 deletions.
1 change: 1 addition & 0 deletions .github/wiki/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ buttons = {
### Assets

Override icons and text for specific filetypes or filenames. Most of the options also support functions.
See

```lua
assets = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ require('cord').setup {

## Icon Configuration Options

| Option | Type | Description |
| ----------- | ----------------- | ------------------------------------------------------------------------------------------------------------ |
| **(key)** | `string` | The key can be a Vim filetype (like `lua`), a filename (like `Cargo.toml`), or a file extension (like `.rs`) |
| **(value)** | `string \| table` | This can either be a string pointing to the icon or a table with options below |
| `icon` | `string` | A direct URL to the icon image or the name of the rich presence asset (in case you use your own application) |
| `tooltip` | `string` | Text that appears when hovering over the icon |
| `name` | `string` | An optional override for the icon name. Redundant for `language` types |
| `text` | `string` | An optional override for the icon text. Unlike other options, this will fully override the text |
| `type` | `string` | Specifies the context of the asset. |
| Option | Type | Description |
| ----------- | --------------------- | ------------------------------------------------------------------------------------------------------------ |
| **(key)** | `string` | The key can be a Vim filetype (like `lua`), a filename (like `Cargo.toml`), or a file extension (like `.rs`) |
| **(value)** | `string \| table` | This can either be a string pointing to the icon or a table with options below |
| `icon` | `string \| function ` | A direct URL to the icon image or the name of the rich presence asset (in case you use your own application) |
| `tooltip` | `string \| function` | Text that appears when hovering over the icon |
| `name` | `string \| function` | An optional override for the icon name. Redundant for `language` types |
| `text` | `string \| function` | An optional override for the icon text. Unlike other options, this will fully override the text |
| `type` | `string` | Specifies the context of the asset. |

Available types:
- `language` (default)
Expand Down
12 changes: 6 additions & 6 deletions .github/wiki/Home.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Welcome to the **cord.nvim** wiki!

- [Migration from v1](Migration)
- [Configuration](Configuration)
- [Examples](Examples.md)
- [Add or change file icons](Add-or-change-file-icons)
- [Troubleshooting](Troubleshooting)
- [Contributing](Contributing)
- [Migrating from v1](https://github.com/vyfor/cord.nvim/wiki/Migration)
- [Configuration](https://github.com/vyfor/cord.nvim/wiki/Configuration)
- [Examples](https://github.com/vyfor/cord.nvim/wiki/Examples)
- [Add or Change File Icons](https://github.com/vyfor/cord.nvim/wiki/File-Icons)
- [Troubleshooting](https://github.com/vyfor/cord.nvim/wiki/Troubleshooting)
- [Contributing](https://github.com/vyfor/cord.nvim/wiki/Contributing)
6 changes: 3 additions & 3 deletions .github/wiki/Migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The plugin in question, **cord.nvim**, has been rewritten from scratch with a ne
The config structure has been updated to be more flexible. Most notably, the majority of string options now support functions, giving you full control over the Rich Presence display. Additionally, a new `variables` option has been introduced to allow custom dynamic values in text templates.

> [!NOTE]
> Full configuration options can be found [here](Configuration.md).
> Full configuration options can be found [here](https://github.com/vyfor/cord.nvim/wiki/Configuration).
### Changed Options
```lua
Expand Down Expand Up @@ -71,7 +71,7 @@ Several built-in features have been removed in favor of customization through fu
- Problem count
- ToggleTerm handling

These can now be implemented using hooks and custom functions. See [examples](Examples.md).
These can now be implemented using hooks and custom functions. See [examples](https://github.com/vyfor/cord.nvim/wiki/Examples).

## 🎨 Function-Based Customization

Expand Down Expand Up @@ -115,4 +115,4 @@ assets = {
}
```

More information can be found in the [Configuration Guide](Configuration.md).
More information can be found in the [Configuration Guide](https://github.com/vyfor/cord.nvim/wiki/Configuration).
2 changes: 1 addition & 1 deletion .github/wiki/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
### Rich Presence is not shown in Discord
1. Ensure that `cord.nvim` is loaded (try running a user command, e.g. `:Cord status`)
2. Confirm that your Activity Privacy settings are [enabled](https://github.com/vyfor/cord.nvim/assets/92883017/c0c8c410-e90e-425e-bf10-8b59f04f15ce)
3. Set [`advanced.plugin.log_level`](./Configuration.md#️-advanced) to `vim.log.levels.TRACE` and check `:messages` for logs
3. Set [`advanced.plugin.log_level`](https://github.com/vyfor/cord.nvim/wiki/Configuration#️-advanced) to `vim.log.levels.TRACE` and check `:messages` for logs
4. Verify that the Discord IPC pipe exists:

**Windows:**
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/wiki.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
path: .github/wiki
preprocess: true
strategy: init
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,14 +134,14 @@ Cord features over 70 beautifully designed icons for languages and components wi
πŸ‘‰ [**Explore the Showcase**](https://github.com/vyfor/icons#showcase)

## πŸ“– Documentation
- [**Configuration Guide**](.github/wiki/Configuration.md): Everything you need to customize Cord.
- [**Examples**](.github/wiki/Examples.md): Creative ways to customize your Discord presence.
- [**Migration Guide**](.github/wiki/Migration.md): Smooth migration from Cord v1.
- [**Wiki**](https://github.com/vyfor/cord.nvim/wiki): Examples, best practices, and FAQs. (Coming soon)
- [**Configuration Guide**](https://github.com/vyfor/cord.nvim/wiki/Configuration): Everything you need to customize Cord.
- [**Examples**](https://github.com/vyfor/cord.nvim/wiki/Examples): Creative ways to customize your Discord presence.
- [**Migration Guide**](https://github.com/vyfor/cord.nvim/wiki/Migration): Smooth migration from Cord v1.
- [**Wiki**](https://github.com/vyfor/cord.nvim/wiki): Examples, best practices, and FAQs.

## 🀝 Contributing
We welcome contributions to make Cord even better!
- Check out our [**Contribution Guidelines**](.github/wiki/Contributing.md).
- Check out our [**Contribution Guidelines**](https://github.com/vyfor/cord.nvim/wiki/Contributing).

## ❓ FAQ
Have questions or issues?
Expand Down

0 comments on commit efbfa36

Please sign in to comment.