Skip to content

Commit

Permalink
Sync demo content
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored and alcarney committed Jan 17, 2025
1 parent f0a284c commit cb665ec
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
30 changes: 30 additions & 0 deletions myst/directives.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,33 @@ The most obvious feature is the completion suggestions, try inserting a `{note}`
% Add your note here...

Notice how VSCode automatically presented you with a list of all the directives you can use in this Sphinx project?

### Arguments

While directive names Just Work{sup}`TM`, Esbonio is only able to offer suggestions for specific argument types.
By default Esbonio can provide suggestions for

**Filepaths**

Completing filepath arguments is supported for the following directives

- [`figure`](https://docutils.sourceforge.io/docs/ref/rst/directives.html#figure)
- [`image`](https://docutils.sourceforge.io/docs/ref/rst/directives.html#image)
- [`include`](https://docutils.sourceforge.io/docs/ref/rst/directives.html#image)
- {external+sphinx:rst:dir}`literalinclude`

% Try using the `literalinclude` directive to insert the contents of this project's conf.py here...


**Pygments Lexers**

Sphinx uses the [pygments](https://pygments.org/) library for its syntax highlighting, Esbonio will offer the names of available lexers as suggestions for the following directives.

- {external+sphinx:rst:dir}`code`
- {external+sphinx:rst:dir}`code-block`
- {external+sphinx:rst:dir}`highlight`
- {external+sphinx:rst:dir}`sourcecode`

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

% Try inserting a code block on the next line...
28 changes: 28 additions & 0 deletions rst/directives.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,31 @@ The most obvious feature is the completion suggestions, try inserting a ``.. not
.. Add your note here...
Notice how VSCode automatically presented you with a list of all the directives you can use in this Sphinx project?

Arguments
^^^^^^^^^

While directive names Just Work\ :sup:`TM`, Esbonio is only able to offer suggestions for specific argument types.
By default Esbonio can provide suggestions for

**Filepaths**

Completing filepath arguments is supported for the following directives

- `figure <https://docutils.sourceforge.io/docs/ref/rst/directives.html#figure>`__
- `image <https://docutils.sourceforge.io/docs/ref/rst/directives.html#image>`__
- `include <https://docutils.sourceforge.io/docs/ref/rst/directives.html#image>`__
- :external+sphinx:rst:dir:`literalinclude`

.. Try using the `literalinclude` directive to insert the contents of this project's conf.py here...
**Pygments Lexers**

Sphinx uses the `pygments <https://pygments.org/>`__ library for its syntax highlighting, Esbonio will offer the names of available lexers as suggestions for the following directives.

- :external+sphinx:rst:dir:`code`
- :external+sphinx:rst:dir:`code-block`
- :external+sphinx:rst:dir:`highlight`
- :external+sphinx:rst:dir:`sourcecode`

.. Try inserting a code block on the next line...

0 comments on commit cb665ec

Please sign in to comment.