obsidian-plugin/manibatra_obsidian-text2anki-openai
1
0
Fork 0
mirror of https://github.com/manibatra/obsidian-text2anki-openai.git synced 2026-07-22 07:40:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
13 commits 1 branch 1 tag 89 KiB
TypeScript 81.3%
JavaScript 17%
CSS 1.7%
Find a file
Mani Batra 0e5b9b5a7f
Remove unused code
2023-03-27 23:04:05 +11:00
.editorconfig Initial commit 2023-03-21 20:48:36 +11:00
.eslintignore Initial commit 2023-03-21 20:48:36 +11:00
.eslintrc Initial commit 2023-03-21 20:48:36 +11:00
.gitignore Initial commit 2023-03-21 20:48:36 +11:00
.npmrc Initial commit 2023-03-21 20:48:36 +11:00
esbuild.config.mjs Initial commit 2023-03-21 20:48:36 +11:00
LICENSE Create LICENSE 2023-03-24 22:37:11 +11:00
main.ts Remove unused code 2023-03-27 23:04:05 +11:00
manifest.json Update name to remove obsidian 2023-03-24 22:56:29 +11:00
package-lock.json Update name to remove obsidian 2023-03-24 22:56:29 +11:00
package.json Update name to remove obsidian 2023-03-24 22:56:29 +11:00
README.md Update name to remove obsidian 2023-03-24 22:56:29 +11:00
styles.css Initial commit 2023-03-21 20:48:36 +11:00
tsconfig.json Initial commit 2023-03-21 20:48:36 +11:00
version-bump.mjs Initial commit 2023-03-21 20:48:36 +11:00
versions.json Initial commit 2023-03-21 20:48:36 +11:00

README.md

Text2Anki using OpenAI

Flashcard Generator Plugin for Obsidian

The Flashcard Generator plugin automatically generates flashcards from your Obsidian notes using the OpenAI API and pushes them to a local Anki app.

Features

  • Automatically generate flashcards from bullet points(they work best) in Obsidian notes.
  • Push generated flashcards to the Anki app.
  • Specify a custom deck name for the generated flashcards in Anki.
  • Configure the OpenAI GPT model to use for flashcard generation.
  • Specify a custom user prompt to be used for generating the flashcards.

Usage

  1. Open a note in Obsidian.
  2. Run the "Generate flashcards from current file" command. The plugin will extract flashcards from the note and push them to the Anki app running locally.

To specify a custom deck name for the generated flashcards, add a line at the beginning of the note in the following format:

Deck: Computer Science::Python

Settings

You can configure the following settings in the Flashcard Generator plugin:

  1. OpenAI API Key: Add your OpenAI API key to enable the flashcard generation feature.
  2. Anki Deck Name: Specify the default Anki deck name where flashcards will be added.
  3. OpenAI GPT Model Name: Select the OpenAI GPT model to use for flashcard generation.

Dependencies

This plugin requires the following dependencies:

  • Obsidian
  • OpenAI (openai)
  • Anki app running locally with AnkiConnect installed

Known Issues

If you encounter any issues, please report them on the GitHub issues page.