Skip to content

Commit 923b35a

Browse files
committed
Add links to example .tmuxp.yaml files
1 parent 172e203 commit 923b35a

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

doc/examples.rst

+18
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,24 @@ JSON
223223
.. literalinclude:: ../.tmuxp.json
224224
:language: json
225225

226+
Project configs
227+
---------------
228+
229+
tmuxp supports loading configs via absolute filename with ``tmuxp load``
230+
and via ``$ tmuxp load .`` if config is in directory.
231+
232+
To make a per-project config, use ``.tmuxp.yaml`` and ``.tmuxp.json`` in
233+
the root of your project directory.
234+
235+
See examples of ``tmuxp`` in the wild. Have a project config to show off?
236+
Edit this page.
237+
238+
* https://github.com/tony/dockerfiles/blob/master/.tmuxp.yaml
239+
* https://github.com/tony/pullv/blob/master/.tmuxp.yaml
240+
* https://github.com/tony/sphinxcontrib-github/blob/master/.tmuxp.yaml
241+
242+
You can use ``start_directory: ./`` to make the directories relative to
243+
the config file / project root.
226244

227245
Kung fu
228246
-------

0 commit comments

Comments
 (0)