Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
VoltaireNoir committed Oct 28, 2023
1 parent dd69ea6 commit 68fbf85
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Expand Up @@ -19,12 +19,13 @@ All paths are ensured to be valid ones, relative paths are stored in their expan

Run `markd help` for a full list of supported commands and arguments. Run `markd <COMMAND> --help` to get more info on the command.

> Note: bookmarks are stored in `bookmarks.json` file in the user home directory in the form of `"name":"path"`, which can also be directly edited if necessary.
> Note: bookmarks are stored in `bookmarks.toml` file in the user home directory in the form of `name = "path"`, which can also be directly edited if necessary.
## Shell Support
Since 'cd' is a built-in shell command, you need to use 'command substitution' to make use of markd to switch directories.
To make it work, simply add a function definition to your shell config file. After adding the necessary code to your shell config, you should be able to jump between directories using the command `goto <bookmark-name>`.
> Note: The function name used here is 'goto' but you can change it to whatever you prefer.
> The following shell functions can also be generated to stdout by running the command `markd shell <shell_name>`
### Fish
- Create a `functions` directory in fish config folder (usually `/home/user/.config/fish`)
Expand Down

0 comments on commit 68fbf85

Please sign in to comment.