Skip to content

octagonn/CourseForge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CourseForge

Obsidian plugin that turns certification docs into a structured course with lessons, activities, quizzes, citations, and a progress dashboard.

Setup

  1. Copy main.js, manifest.json, and styles.css into your vault's .obsidian/plugins/courseforge/ folder.
  2. Enable the plugin in Obsidian Settings → Community plugins.
  3. In CourseForge settings, choose a provider (OpenAI, Google Gemini, or Hugging Face), pick a model from the dropdown, and set your API key. Set the default course folder if you like.

UI

  • Ribbon icon (graduation cap) — Opens the CourseForge panel in a side pane with quick-action buttons for all commands.
  • CourseForge: Open CourseForge — Same panel from the command palette.

Commands

  • CourseForge: Create course from URLs — Create a new course folder and structure from a title and list of doc URLs.
  • CourseForge: Add sources to existing course — Fetch more URLs and append sources + chunks to an existing course.
  • CourseForge: Generate module lessons — Generate syllabus if needed, then pick a module and generate a lesson note with citations.
  • CourseForge: Generate activities for module — Pick a module and generate an activities note.
  • CourseForge: Generate quiz for module — Pick a module and generate a quiz with answer key and explanations.
  • CourseForge: Review session — Refresh the dashboard and build Review Queue with links to lessons, activities, and quizzes.

Vault structure

Courses live under a folder you choose. Each course has:

  • 00 - Dashboard.md, 00 - Syllabus.md
  • Sources/sources.json, Sources/chunks.jsonl, course_state.json
  • Modules/ (lessons, activities), Modules/Quizzes/
  • Review/Review Queue.md
  • _templates/ (Lesson, Activity, Quiz templates)

Data is local-first; API keys are stored only in plugin settings, not in vault files.

Build

npm install
npm run build

Requires Node 18+ and Obsidian 0.15+.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors