Move most of the documentation to .rst format

This commit is contained in:
Noah Gorny
2020-10-25 14:51:02 +02:00
parent 6abb26c6c6
commit f7e295f691
15 changed files with 822 additions and 6 deletions

18
docs/custom.rst Normal file
View File

@@ -0,0 +1,18 @@
.. _custom:
Custom Content
--------------
For custom scripts, and aliases, just create the following files (they'll be ignored by the git repo):
* ``aliases/custom.aliases.bash``
* ``completion/custom.completion.bash``
* ``lib/custom.bash``
* ``plugins/custom.plugins.bash``
* ``custom/themes/<custom theme name>/<custom theme name>.theme.bash``
Anything in the custom directory will be ignored, with the exception of ``custom/example.bash``.
Alternately, if you would like to keep your custom scripts under version control, you can set ``BASH_IT_CUSTOM`` in your ``~/.bashrc`` to another location outside of the ``$BASH_IT`` folder.
In this case, any ``*.bash`` file under every directory below ``BASH_IT_CUSTOM`` folder will be used.