Hacking the Source Code
=======================

By `Lex Li`_

Build from source
-----------------
#. Clone the repo to a local path such as ``/Users/someuser/vscode-restructuredtext``.
#. Navigate to this folder.
#. Resolve Node.js dependencies via ``yarn install`` .
#. Build via ``yarn compile`` .
#. Configure Sphinx following :doc:`/articles/configuration` .
#. Run VS Code from this folder via ``code .`` .
#. In this editing VS Code instance, press F5 to start a debugging instance.

.. code-block:: text

    cd /Users/someuser
    git clone https://github.com/vscode-restructuredtext/vscode-restructuredtext.git
    cd vscode-restructuredtext
    yarn install
    yarn compile
    code .

.. note:: To configure the ``code`` command, please follow `this guide <https://code.visualstudio.com/docs/setup/setup-overview>`_ .

You can now open a test folder in this debugging instance.

Debugging with Esbonio
----------------------
.. danger:: Starting from version 190.1.17, this feature is removed. You will
   be recommended to install Esbonio extension instead. To learn more about how
   to configure Esbonio, you can visit `this site <https://docs.esbon.io>`_.

Publish to Marketplace
----------------------
To publish this extension, use `vsce <https://code.visualstudio.com/docs/tools/vscecli>`_ .

.. code-block:: text

    cd /Users/someuser
    git clone https://github.com/vscode-restructuredtext/vscode-restructuredtext.git
    cd vscode-restructuredtext
    vsce publish

Related Resources
-----------------

- :doc:`/articles/configuration`
- :doc:`/articles/shortcuts`
- :doc:`/articles/troubleshooting`