Skip to content

Latest commit

 

History

History
39 lines (20 loc) · 1.67 KB

README.md

File metadata and controls

39 lines (20 loc) · 1.67 KB

ReadTheDocs

This addin brings a set of snippets which can be used when creating documentation for the ReadTheDocs site.

Usage

There are currently 3 snippets included in this VS Code extension. To use them, simply open your markdown file, and then type rtd followed by ctrl-space. This will then show the available snippets...

Available RTD Snippets

and then simply arrow up/down to the one you want and press enter, or left mouse click. From there the HTML will be generated, and the cursor will be placed ready for you to start filling in the content of the callout...

Expanded RTD Snippet

rtdAttention

This will create a callout similar to the following:

Attention Callout

rtdNote

This will create a callout similar to the following:

Note Callout

rtdError

This will create a callout similar to the following:

Error Callout

Contribution

If you would like to see any other snippet added for this VS Code Extension, feel free to raise an issue.

Releases

To find out what was released in each version of this extension, check out the releases page.