Editor Enhancement

By Lex Li

This article shows how this extension enhances the editor.

Section Builder

Sphinx supports a few underline characters that can be used in section headers, such as =, -, :, ., \, ", ~, ^, *, +, and #.


Though ` and _ are also valid in Sphinx syntax, the syntax file used by this extension does not work well with them. So these two are not supported by this feature.

The keyboard shortcuts are,




Insert Adornment

ctrl+k ctrl+=

cmd+k cmd+=

Insert Adornment (Reversed)

ctrl+k ctrl+-

cmd+k cmd+-


To learn all keyboard shortcuts of this extension, please refer to Keyboard Shortcuts.

Pressing the shortcut key would convert the current line under the cursor to a section, by adding adornment (underlines below the title text).

Pressing the shortcut key multiple times switches among the adornment characters.

List Editor

The list editor was ported from VSCode Markdown extension, which provides the several functionalities to simplify list editing.

You can refer to this page to learn more.

Table Editor

As an experiment, table editor has been ported from Tatsuya Nakamori’s extension, which provides the following functionalities,

  • Create empty table from simple text such as 3x4.

  • Create formatted table from comma separated text.

  • Add/delete table row/column

You can refer to this article for more information.


To avoid conflicts with IntelliSense, the ported table editor uses a different approach to trigger empty table creation,

  1. Start in a new line in the editor.

  2. Type text such as 3x4.

  3. Select the text and right click.

  4. Choose the menu item “Create a grid of tables”.

Code Navigation

The project/file structure is displayed as breadcrumbs so that navigation among sections is easy.