add 'custom' module for easy customization
This commit is contained in:
parent
9302507257
commit
d52993c70e
4 changed files with 31 additions and 0 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1,2 +1,3 @@
|
||||||
*.swp
|
*.swp
|
||||||
*.zwc
|
*.zwc
|
||||||
|
custom/
|
||||||
|
|
18
modules/custom/README.md
Normal file
18
modules/custom/README.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
Custom
|
||||||
|
======
|
||||||
|
|
||||||
|
Add any custom aliases/settings to the `init.zsh` file.
|
||||||
|
|
||||||
|
Any functions should go in the `functions` folder, where the name of the file is the name of the function.
|
||||||
|
|
||||||
|
For example, this function from your .zshrc:
|
||||||
|
```
|
||||||
|
foo() {
|
||||||
|
print 'bar'
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
becomes a file named 'foo' in the functions folder containing:
|
||||||
|
```
|
||||||
|
print 'bar'
|
||||||
|
```
|
4
modules/custom/functions/example_function
Normal file
4
modules/custom/functions/example_function
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
# this is an example function
|
||||||
|
# running 'example_function' in a zsh session will execute the code below
|
||||||
|
|
||||||
|
print "executed example function: ${ZDOTDIR:-${HOME}}/modules/custom/functions/example_function!"
|
8
modules/custom/init.zsh
Normal file
8
modules/custom/init.zsh
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
#
|
||||||
|
# Custom aliases/settings
|
||||||
|
#
|
||||||
|
|
||||||
|
# any custom stuff should go here.
|
||||||
|
# ensure that 'custom' exists in your zmodules array in .zshrc
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue