https://github.com/realpython/author-tools
VS Code extension with a set of tools to help Real Python authors
https://github.com/realpython/author-tools
Last synced: 7 months ago
JSON representation
VS Code extension with a set of tools to help Real Python authors
- Host: GitHub
- URL: https://github.com/realpython/author-tools
- Owner: realpython
- Created: 2018-10-29T22:37:28.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-07T04:19:42.000Z (almost 7 years ago)
- Last Synced: 2025-05-07T21:04:56.762Z (7 months ago)
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=RealPython.author-tools
- Size: 130 KB
- Stars: 5
- Watchers: 5
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Real Python Author Tools
This is a Visual Studio Code extension with a set of tools that will help authors for [realpython.com](https://realpython.com)
Open an issue on the [repo here](https://github.com/realpython/author-tools).
## Setup
Just hit install!
If installing this extension directly from the repo, copy it into your local `/.vscode/extensions` folder and restart VS Code.
Works best with `editor.tabCompletion` enabled (`on`) in your VS Code `Settings`.
## Snippet Usage
To access the list of snippets, use the `ctrl+Space` ande then simply type `rp` to start using any of the snippets. The full list of snippets is below.
This extension works best with `editor.tabCompletion` enabled (`on`) in your VS Code `Settings`.
## Changelog
The full changelog can be found [here](CHANGELOG.md).
## Documentation
### General Snippets
| Prefix | Output |
| ------------ | ----------------------------------------------------------- |
| `rpcode` | adds a simple code block |
| `rpcodeline` | adds a code block with line nums |
| `rpcodehl` | adds a code block with highlighted lines |
| `rpcodeall` | adds a code block with both line nums and highlighted lines |
| `rpimg` | adds a simple img block |
| `rpimgatr` | adds a img block with commonly used attributes |
| `rpimgeall` | adds an img block with all attributes |
| `rpdir` | adds an example file directory block |
| `rpalert` | adds an alert box |
| `rpwarn` | adds a warning box |
| `rpnote` | adds a note box |
| `rpcollapse` | adds a collapse box |
| `rpexercise` | adds an exercise block |
| `rpquote` | adds a quote block |
## Release Notes
### 2018.10.0
- Initial release
---