wip

.github/workflows/sync-repos.yml

@@ -0,0 +1,23 @@
+name: Synchronize Repositories
+
+on:
+  push: 
+    branches:
+    - beta
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Sync esbonio-demo
+      uses: cpina/[email protected]
+      env:
+        SSH_DEPLOY_KEY: ${{ secrets.DEMO_DEPLOY_KEY }}
+      with:
+        source-directory: 'lib/esbonio/tests/workspaces/esbonio-demo'
+        destination-repository-name: 'esbonio-demo'  
+        user-name: 'github-actions[bot]'  
+        user-email: '41898282+github-actions[bot]@users.noreply.github.com'  
+

.vscode/launch.json

@@ -35,7 +35,7 @@
             "args": [
                 "--extensionDevelopmentPath=${workspaceRoot}/code",
                 "--folder-uri=${workspaceRoot}/docs",
-                "--folder-uri=${workspaceRoot}/lib/esbonio/tests/sphinx-default/workspace"
+                "--folder-uri=${workspaceRoot}/lib/esbonio/tests/workspaces/esbonio-demo"
             ],
             "outFiles": [
                 "${workspaceRoot}/code/dist/node/**/*.js"

code/package.json

@@ -277,7 +277,6 @@
                 }
             }
         ],
-        "keybindings": [],
         "languages": [
             {
                 "id": "restructuredtext",
@@ -309,6 +308,18 @@
                 "path": "./syntaxes/esbonio-log-output.tmLanguage.json"
             }
         ],
+        "keybindings": [
+            {
+                "command": "esbonio.preview.open",
+                "key": "ctrl+shift+v",
+                "when": "editorTextFocus && editorLangId == restructuredtext"
+            },
+            {
+                "command": "esbonio.preview.openSide",
+                "key": "ctrl+k v",
+                "when": "editorTextFocus && editorLangId == restructuredtext"
+            }
+        ],
         "menus": {
             "editor/title": [
                 {

docs/extensions/relevant_to.rst

@@ -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::
 
@@ -74,9 +74,4 @@ Then within your documentation, "relevant sections" are defined using the :rst:d
 
    The body of a definition can contain most reStructuredText constructs including roles and directives
 
-   .. literalinclude:: /lsp/getting-started.rst
-      :language: rst
-      :start-at: .. relevant-to:: Editor
-      :end-before: Emacs
-
    However section titles are not supported.

docs/index.rst

@@ -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
 
@@ -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
@@ -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/reference
    changelog