Egbert is a blogging AI assistant who will provide metadata for your blog posts based on the content of your posts.
This VSCode extension is not yet published on any marketplace. To test it out in your own environment:
- Clone this repository and run
npm install - Run
npm run vscode:packageto create a VSIX file - Install the VSIX file in VSCode by opening the command palette and selecting
Extensions: Install from VSIX...
A sample egbert.yaml file is located in /test-content/egbert.yaml. You can copy this file to your workspace directory and customize it to your liking.
Important: You will need to provide your own OpenAI API key.
By default, Egbert will supply you with some suggested titles, some summaries, and a sentiment analysis of your post, but you can customize the instructions Egbert uses by supplying a 'egbert.yaml' file in your workspace directory.
Egbert responds by updating the YAML front matter of your blog posts. (If you are not using YAML front matter, Egbert will create it for you anyway and it will be up to you to decide what to do with it.)
Important: You will need to provide your own OpenAI API key.
Include if your extension adds any VS Code settings through the contributes.configuration extension point.
For example:
This extension contributes the following settings:
egbert.openAIKey: The OpenAI Api Key to use for Egbert.
Egbert is still in development. Please report any issues you find, or any suggestions you have, to the Egbert Github Issues Page.
Initial release of Egbert.
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\on macOS orCtrl+\on Windows and Linux). - Toggle preview (
Shift+Cmd+Von macOS orShift+Ctrl+Von Windows and Linux). - Press
Ctrl+Space(Windows, Linux, macOS) to see a list of Markdown snippets.
Enjoy!