Directives

This page provides an overview of the features Esbonio provides to make working with MyST Directives easier.

Completion

The most obvious feature is the completion suggestions, try inserting a {note} directive on the next line

In addition to directive names, Esbonio supports suggesting values many kinds of arguments given to a directive, including.

Filepaths

Completing filepath arguments is supported for the following directives

• figure

• image

• include

• literalinclude

Pygments Lexers

Sphinx uses the pygments library for its syntax highlighting. Esbonio will offer the names of available lexers as suggestions for the following directives.

• code

• code-block

• highlight

• sourcecode

Of course MyST allows you to use standard Markdown code blocks as well, Esbonio will also offer suggestions in this context.

Document Links

Many text editors will automatically detect links to webpages, e.g., https://sphinx-doc.org, and make them clickable. The textDocument/documentLink request allows language servers to do the same.

When it makes sense to, esbonio will add clickable links to many directive arguments, including:

• Local files

  ```{include} ./directives.md
  ```
  

GoTo…

… Definition

Esbonio supports GoTo Definition requests for directive arguments, including:

• Local files

  ```{include} ./symbols.md
  ```