Skip to content

Commit

Permalink
docs: add setting ids list
Browse files Browse the repository at this point in the history
  • Loading branch information
Vinzent03 committed Aug 3, 2022
1 parent 08832d1 commit 9a0305f
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/docs/actions/miscellaneous.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 6
---

# Miscellaneous
Expand Down
18 changes: 9 additions & 9 deletions docs/docs/actions/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ sidebar_position: 1

# Navigation

| / | parameters | explanation |
| ---------------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| workspace | workspace | Opens the workspace called `workspace` |
| save current workspace | saveworkspace=true | Saves the current workspace. (Can be combined with `workspace` to open a new workspace afterwards) |
| file | <identification\> | Opens file |
| line in file | <identification\>, line | Opens line `line` in file |
| heading | <identification\>, heading | Opens the `heading` in file |
| block reference | <identification\>, block | Opens the `block` in file |
| settings tab | settingid | Opens a settings tab by id, all plugins are supported (e.g. `editor`, `community-plugins`, `plugin-browser`, `theme-browser`...) |
| / | parameters | explanation |
| ---------------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| workspace | workspace | Opens the workspace called `workspace` |
| save current workspace | saveworkspace=true | Saves the current workspace. (Can be combined with `workspace` to open a new workspace afterwards) |
| file | <identification\> | Opens file |
| line in file | <identification\>, line | Opens line `line` in file |
| heading | <identification\>, heading | Opens the `heading` in file |
| block reference | <identification\>, block | Opens the `block` in file |
| settings tab | settingid | Opens a settings tab by id, all plugins are supported. See [here](settings_navigation.md) for a list of all available options |


:::note Example
Expand Down
54 changes: 54 additions & 0 deletions docs/docs/actions/settings_navigation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
sidebar_position: 5
---

# Settings Navigation


:::info
The settings tab of every community plugin can be opened by the plugin's id. The id can be found in `<your-vault>/.obsidian/plugins/<your-plugin>/manifest.json`.
:::

## Obsidian settings

| id | Meaning |
| ----------------- | ----------------- |
| editor | Editor |
| file | File & Links |
| appearance | Appearance |
| hotkeys | Hotkeys |
| about | About |
| account | Account |
| core-plugins | Core plugins |
| community-plugins | Community plugins |

## Obsidian stores

| id | Meaning |
| -------------- | -------------- |
| theme-browser | Theme browser |
| plugin-browser | Plugin browser |


## Core plugin settings

| id | Meaning |
| --------------- | --------------- |
| note-composer | Note composer |
| backlink | Backlink |
| switcher | Quick Switcher |
| command-palette | Command palette |
| daily-notes | Daily notes |
| file-recovery | File recovery |
| page-preview | Page Preview |


:::note Example
```uri
obsidian://advanced-uri?vault=<your-vault>&settingid=editor
```
:::

:::note Source
Thanks to [hyaray](https://github.com/hyaray) for collecting all setting ids on the [Obsidian forum](https://forum-zh.obsidian.md/t/topic/7365)
:::

0 comments on commit 9a0305f

Please sign in to comment.