# Source: https://github.com/openlawlibrary/pygls/blob/main/docs/source/servers/getting-started.rst

Getting Started
===============

.. _example-servers:

Example Servers
---------------

.. toctree::
   :hidden:
   :glob:

   examples/*

.. tip::

   If you use VSCode, we recommend you try these servers out in the :ref:`pygls-playground <howto-use-pygls-playground>` extension

Each of the following example servers are focused on implementing a particular subset of the Language Server Protocol.

.. grid:: 1 2 2 4
   :gutter: 2

   .. grid-item-card:: Code Actions
      :link: examples/code-actions
      :link-type: doc
      :text-align: center

      :octicon:`light-bulb`

   .. grid-item-card:: Code Lens
      :link: examples/code-lens
      :link-type: doc
      :text-align: center

      :octicon:`eye`

   .. grid-item-card:: Colors
      :link: examples/colors
      :link-type: doc
      :text-align: center

      :octicon:`paintbrush`

   .. grid-item-card:: Formatting
      :link: examples/formatting
      :link-type: doc
      :text-align: center

      :octicon:`typography`

   .. grid-item-card:: Goto "X"
      :link: examples/goto
      :link-type: doc
      :text-align: center

      :octicon:`search`

   .. grid-item-card:: Hover
      :link: examples/hover
      :link-type: doc
      :text-align: center

      :octicon:`book`

   .. grid-item-card:: Inlay Hints
      :link: examples/inlay-hints
      :link-type: doc
      :text-align: center

      :octicon:`info`

   .. grid-item-card:: Links
      :link: examples/links
      :link-type: doc
      :text-align: center

      :octicon:`link`

   .. grid-item-card:: Publish Diagnostics
      :link: examples/publish-diagnostics
      :link-type: doc
      :text-align: center

      :octicon:`alert`

   .. grid-item-card:: Pull Diagnostics
      :link: examples/pull-diagnostics
      :link-type: doc
      :text-align: center

      :octicon:`alert`

   .. grid-item-card:: Rename
      :link: examples/rename
      :link-type: doc
      :text-align: center

      :octicon:`pencil`

   .. grid-item-card:: Semantic Tokens
      :link: examples/semantic-tokens
      :link-type: doc
      :text-align: center

      :octicon:`file-binary`

   .. grid-item-card:: Symbols
      :link: examples/symbols
      :link-type: doc
      :text-align: center

      :octicon:`code`

These servers are dedicated to demonstrating features of *pygls* itself

.. grid:: 1 2 2 4
   :gutter: 2

   .. grid-item-card:: JSON Server
      :link: examples/json-server
      :link-type: doc
      :text-align: center

      :octicon:`code`

   .. grid-item-card:: Threaded Handlers
      :link: examples/threaded-handlers
      :link-type: doc
      :text-align: center

      :octicon:`columns`


Tutorial
--------

.. note::

   Coming soon\ :sup:`TM`