Skip to content

Commit

Permalink
docs: wip tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
alcarney committed Mar 14, 2024
1 parent 58b938d commit 707e2b5
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/extensions/relevant_to.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Additionally this extension
- Reflects the chosen topic in the page's URL, making subject choices linkable
- Uses `htmx`_ to swap out the relevant sections.

See the Esbonio language server's :ref:`lsp_getting_started` guide for an example of this extension in action.
See the Esbonio language server's :ref:`lsp-getting-started` guide for an example of this extension in action.

.. note::

Expand Down
51 changes: 39 additions & 12 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,48 @@ Esbonio

.. rubric:: esbonio -- (v.) to explain

Esbonio aims to make it easier to work with `reStructuredText`_ tools such as
`Sphinx`_ by providing a `Language Server`_ to enhance your editing experience.
Esbonio is a `Language Server`_ for `Sphinx`_ documentation projects.

Esbonio aids the writing process by resolving references, providing completion suggestions and highlighting errors.
It ensures your local build is always up to date, allowing you to preview your changes in (almost!) real-time.
The server itself can even be extended to better suit the needs of your project.

The primary goal of Esbonio is to reduce the friction that comes from trying to remember the specifics of a markup language, so that you can focus on your content and not your tooling.

.. grid:: 2
:gutter: 1

.. grid-item-card:: Getting Started
:text-align: center
:link: lsp-getting-started
:link-type: ref

Using Esbonio for the first time within VSCode.

.. grid-item-card:: How-To Guides
:text-align: center

Step-by-step guides on integrating Esbonio with other text editors.

.. grid-item-card:: Reference
:text-align: center
:link: lsp-reference
:link-type: ref

Configuration options, API documentation, architecture diagrams and more.

.. grid-item-card:: Extending
:text-align: center
:link: lsp-extending
:link-type: ref

Documentation on extendining the Esbonio language server


Language Server
---------------

Here is a quick summary of the features implemented by the language server.
Below are some of the features provided by the language server.

.. collection:: features

Expand Down Expand Up @@ -74,15 +109,6 @@ Here is a quick summary of the features implemented by the language server.
:align: center
:target: /_images/implementation-demo.gif

- See the :ref:`lsp_getting_started` guide for details on how to get up and
running.

- For further details on more advanced use cases, see the :ref:`lsp-advanced` section.

- Interested in adding support for your own Sphinx extensions?
See the section on :ref:`lsp-extending` for more information.


.. toctree::
:glob:
:caption: Language Server
Expand All @@ -91,6 +117,7 @@ Here is a quick summary of the features implemented by the language server.

lsp/getting-started
lsp/advanced-usage
lsp/how-to
lsp/extending
lsp/howto
lsp/reference
Expand Down
2 changes: 1 addition & 1 deletion docs/lsp/getting-started.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _lsp_getting_started:
.. _lsp-getting-started:

Getting Started
===============
Expand Down

0 comments on commit 707e2b5

Please sign in to comment.