tpl
/
obsidian-sample-plugin
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix of broken internal links in README.md

This commit is contained in:
SebastianMC 2023-10-21 23:43:42 +02:00
parent c3c8453561
commit 61958721cb
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -39,8 +39,8 @@ sorting-spec: |
--- ---
``` ```
Click the ribbon button (![Inactive](./docs/icons/icon-inactive.png) or ![Static icon](./docs/icons/icon-mobile-initial.png) on phone) to tell the plugin to read the sorting specification and apply it. Click the ribbon button (![Inactive](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-inactive.png) or ![Static icon](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-mobile-initial.png) on phone) to tell the plugin to read the sorting specification and apply it.
The sorting should be applied to the folder. On desktops and tablets the ribbon icon should turn (![Active](./docs/icons/icon-active.png)) The sorting should be applied to the folder. On desktops and tablets the ribbon icon should turn (![Active](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-active.png))
!!! **Done!** !!! !!! **Done!** !!!
@ -48,17 +48,17 @@ You should see the files and sub-folders in your folder sorted in reverse alphab
An illustrative image which shows the reverse alphabetical order applied to the root folder of some vault: An illustrative image which shows the reverse alphabetical order applied to the root folder of some vault:
![Basic example](./docs/svg/simplest-example-3.svg) ![Basic example](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/svg/simplest-example-3.svg)
--- ---
### Remarks ### Remarks
> Remarks: > Remarks:
> - your new `sortspec` note should [look like this](./docs/examples/basic/sortspec.md?plain=1) except for the syntax highlighting, which could differ > - your new `sortspec` note should [look like this](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/examples/basic/sortspec.md?plain=1) except for the syntax highlighting, which could differ
> - you will notice that the folders and files are treated equally and thus intermixed > - you will notice that the folders and files are treated equally and thus intermixed
> - the behavior depends on what files and subfolders you have in your folder > - the behavior depends on what files and subfolders you have in your folder
> - changing the sorting order via the standard Obsidian UI button won't affect your folder, unless... > - changing the sorting order via the standard Obsidian UI button won't affect your folder, unless...
> - ...unless you deactivate the custom sorting via clicking the ribbon button to make it (![Inactive](./docs/icons/icon-inactive.png)) > - ...unless you deactivate the custom sorting via clicking the ribbon button to make it (![Inactive](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-inactive.png))
> - for clarity: the underlying file of the note `sortspec` is obviously `sortspec.md` > - for clarity: the underlying file of the note `sortspec` is obviously `sortspec.md`
> - in case of troubles refer to the [TL;DR section of advanced README.md](./blob/master/docs/advanced-README.md#tldr-usage) > - in case of troubles refer to the [TL;DR section of advanced README.md](./blob/master/docs/advanced-README.md#tldr-usage)
> - feel free to experiment! The plugin works in a non-destructive fashion, and it doesn't modify the content of your vault. > - feel free to experiment! The plugin works in a non-destructive fashion, and it doesn't modify the content of your vault.
@ -145,17 +145,17 @@ Click the ribbon icon to toggle the plugin between enabled and suspended states.
States of the ribbon icon on large-screen devices (desktops, laptops and tablets like iPad): States of the ribbon icon on large-screen devices (desktops, laptops and tablets like iPad):
- ![Inactive](./docs/icons/icon-inactive.png) Plugin suspended. Custom sorting NOT applied. - ![Inactive](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-inactive.png) Plugin suspended. Custom sorting NOT applied.
- ![Active](./docs/icons/icon-active.png) Plugin active, custom sorting applied. - ![Active](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-active.png) Plugin active, custom sorting applied.
- ![Error](./docs/icons/icon-error.png) Syntax error in custom sorting configuration. - ![Error](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-error.png) Syntax error in custom sorting configuration.
- ![General Error](./docs/icons/icon-general-error.png) Plugin suspended. General error. - ![General Error](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-general-error.png) Plugin suspended. General error.
- ![Sorting not applied](./docs/icons/icon-not-applied.png) Plugin enabled, but the custom sorting was not applied. - ![Sorting not applied](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-not-applied.png) Plugin enabled, but the custom sorting was not applied.
- ![Static icon](./docs/icons/icon-mobile-initial.png) (Only on large-screen mobile devices like iPad). - ![Static icon](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-mobile-initial.png) (Only on large-screen mobile devices like iPad).
Plugin enabled. but the custom sorting was not applied. Plugin enabled. but the custom sorting was not applied.
On small-screen mobile devices (phones) the icon is static: On small-screen mobile devices (phones) the icon is static:
- ![Static icon](./docs/icons/icon-mobile-initial.png) The icon acts as a button to toggle between enabled and disabled. Its appearance doesn't change - ![Static icon](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-mobile-initial.png) The icon acts as a button to toggle between enabled and disabled. Its appearance doesn't change
For more details on the icon states refer to [Ribbon icon section of the advanced-README.md](./blob/master/docs/advanced-README.md#ribbon-icon) For more details on the icon states refer to [Ribbon icon section of the advanced-README.md](./blob/master/docs/advanced-README.md#ribbon-icon)
@ -164,7 +164,7 @@ For more details on the icon states refer to [Ribbon icon section of the advance
- you might need to activate the custom sorting on your mobile separately, even if on a shared vault the custom sorting was activated on desktop - you might need to activate the custom sorting on your mobile separately, even if on a shared vault the custom sorting was activated on desktop
- the Obsidian command palette being easily available (swipe down gesture on small-screen mobiles) allows for quick steering of the plugin via commands: sort-on and sort-off. - the Obsidian command palette being easily available (swipe down gesture on small-screen mobiles) allows for quick steering of the plugin via commands: sort-on and sort-off.
This could be easier than navigating to and expanding the ribbon This could be easier than navigating to and expanding the ribbon
- the ribbon icon is static (![Static icon](./docs/icons/icon-mobile-initial.png)) and doesn't reflect the state of custom sorting. - the ribbon icon is static (![Static icon](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/icons/icon-mobile-initial.png)) and doesn't reflect the state of custom sorting.
You can enable the _plugin state changes_ notifications in settings, for the mobile devices only You can enable the _plugin state changes_ notifications in settings, for the mobile devices only
## Installing the plugin ## Installing the plugin
@ -186,7 +186,7 @@ in [obsidian-bartender](https://github.com/nothingislost/obsidian-bartender)
Do you want to have a nice-looking horizontal separators in File Explorer like this? Do you want to have a nice-looking horizontal separators in File Explorer like this?
![separators](./docs/img/separators-by-replete.png) ![separators](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/img/separators-by-replete.png)
If so, head on to [Instruction and more context](https://github.com/SebastianMC/obsidian-custom-sort/discussions/57#discussioncomment-4983763) If so, head on to [Instruction and more context](https://github.com/SebastianMC/obsidian-custom-sort/discussions/57#discussioncomment-4983763)
by [@replete](https://github.com/replete)\ by [@replete](https://github.com/replete)\