Skip to content

Commit

Permalink
Update Vimtex documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ahrm committed Dec 11, 2021
1 parent 8d22140 commit b6ff339
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 7 deletions.
26 changes: 25 additions & 1 deletion docs/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,28 @@ If set, we sort the bookmarks by their location instead of their creation time.
:code:`shared_database_path`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The path of :code:`shared.db` database file. You can set this path to be in a synchronized folder (for example a dropbox folder) and sioyek data will be automatically synchronized across your devices.
The path of :code:`shared.db` database file. You can set this path to be in a synchronized folder (for example a dropbox folder) and sioyek data will be automatically synchronized across your devices.

:code:`font_size`
^^^^^^^^^^^^^^^^^

Size of the UI font.

:code:`custom_background_color` and :code:`custom_text_color`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Specify the background and text color when using custom color mode (by executing :code:`toggle_custom_color` command).

.. code-block:: console
custom_background_color 0.18 0.20 0.25
custom_text_color 1.0 1.0 1.0
:code:`startup_commands`
^^^^^^^^^^^^^^^^^^^^^^^^

Semicolon-separated list of commands to execute on startup. For example, to start in custom color mode and in visual scroll mode, you can add the following (the command names are the same as the ones displayed when opening the command window using :code:`:`):

.. code-block:: console
startup_commands toggle_custom_color;toggle_visual_scroll
7 changes: 1 addition & 6 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,12 +184,7 @@ Synctex

- Here is a sample configuration for VimTex::

let g:vimtex_view_general_viewer = 'sioyek'
let g:vimtex_view_general_options = '--reuse-instance'
\ . ' --inverse-search'
\ . '"nvim --headless -c \"VimtexInverseSearch %2 ''%1''\""'
\ . ' --forward-search-file @tex --forward-search-line @line @pdf'
let g:vimtex_view_general_options_latexmk = '--reuse-instance'
let g:vimtex_view_method = 'sioyek'


Data and Synchronization
Expand Down

0 comments on commit b6ff339

Please sign in to comment.