# esbonio

**Repository Path**: mirrors_lextm/esbonio

## Basic Information

- **Project Name**: esbonio
- **Description**: A language server and VSCode extension for working with Sphinx projects. 
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-10
- **Last Updated**: 2026-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <img src="./resources/io.github.swyddfa.Esbonio.svg" alt="Esbonio Project Logo"></img>
</p>
<h1 align="center">Esbonio</h1>

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/swyddfa/esbonio/develop.svg)](https://results.pre-commit.ci/latest/github/swyddfa/esbonio/develop)

**esbonio - (v.) to explain**

Esbonio aims to make it easier to work with [reStructuredText](https://docutils.sourceforge.io/rst.html) tools such as [Sphinx](https://www.sphinx-doc.org/en/master/) by providing a [Language Server](https://langserver.org/) to enhance your editing experience.
The Esbonio project is made up from a number of sub-projects

## `code/` - A VSCode extension for editing Sphinx projects
[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/swyddfa.esbonio?style=flat-square)![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/swyddfa.esbonio?style=flat-square)![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/swyddfa.esbonio?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio)[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/swyddfa/esbonio/blob/develop/code/LICENSE)

<p align="center">
   <img src="./resources/images/vscode-preview-demo.gif" alt="HTML Preview Demo"></img>
</p>

Most of the extension's functionality is provided through...

## `lib/esbonio/` - A Language Server for Sphinx projects.
[![PyPI](https://img.shields.io/pypi/v/esbonio?style=flat-square)![PyPI - Downloads](https://img.shields.io/pypi/dm/esbonio?style=flat-square)](https://pypistats.org/packages/esbonio)[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/swyddfa/esbonio/blob/develop/lib/esbonio/LICENSE)

The language server is still in early development, but already provides the following features.

**Completion**

<p align="center">
  <img src="./resources/images/completion-demo.gif" alt="Completion Suggestions Demo"></img>
</p>

**Definitions**

<p align="center">
  <img src="./resources/images/definition-demo.gif" alt="Goto Definition Demo"></img>
</p>

**Diagnostics**

<p align="center">
  <img src="./resources/images/diagnostic-sphinx-errors-demo.png" alt="Diagnostics Demo"></img>
</p>

**Document Symbols**

<p align="center">
  <img src="./resources/images/document-symbols-demo.png" alt="Document Symbols Demo"></img>
</p>

## `lib/esbonio-extensions/` - A collection of Sphinx extensions
[![PyPI](https://img.shields.io/pypi/v/esbonio-extensions?style=flat-square)![PyPI - Downloads](https://img.shields.io/pypi/dm/esbonio-extensions?style=flat-square)](https://pypistats.org/packages/esbonio-extensions)[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/swyddfa/esbonio/blob/develop/lib/esbonio-extensions/LICENSE)