Skip to content

MaykEu/DeepVault

Repository files navigation

DeepVault

An interactive quiz & learning platform embedded in a single index.html. Zero dependencies. Zero server. Double-click to launch.

License: MIT Live Site


What Is This?

DeepVault is an interactive learning platform for mastering computers, programming, and software engineering — from silicon transistors to C++ templates to real-time networking. It comes pre-loaded with a growing collection of notes and quizzes covering:

  • Computer Systems — from bits and assembly through CPU architecture to GPU
  • C++ Fundamentals — across Core Language, Memory, OOP, and Types
  • Game Math — trigonometry, matrices, quaternions, collision, UE math
  • Unreal Engine Core — UHT, reflection, containers, casting, inheritance
  • UE Networking — RPCs, replication, Iris, GAS prediction
  • Algorithms & Complexity — Big O, amortized analysis, applied examples

Everything stays on your device — no accounts, no servers, no tracking.

Quick Start

  1. Clone this repository — git clone https://github.com/MaykEu/DeepVault.git
  2. Double-click index.html — you're studying
  3. Or visit the live site — no download needed

What It Does

Feature Description
📚 Learn Full Obsidian vault notes rendered to HTML with syntax highlighting, table of contents, wiki links, and callouts
🎯 Quiz hundreds of quiz questions — multiple choice and text input with instant feedback
📊 Progress Track quiz scores per note and folder. Export/import to move between devices
🧭 Guides Learning Paths for every category. Sequential prev/next navigation
🎨 Themes Midnight, Dark, Light, and AMOLED — persistent per-device
🔍 Search Search all notes by title, heading, or content
📱 Mobile Responsive design works on phones
📂 Subfolders Collapsible groups mirror your Obsidian vault structure

Architecture

index.html   →  Double-click to launch
convert.py   →  Rebuild data.js from Obsidian vault
guide-content.txt  →  Static guide page content
SKILL.md     →  Full AI contributor reference
css/         →  base.css + layout.css + components.css (4 themes)
js/          →  13 vanilla JS files, zero frameworks

See SKILL.md for the complete architecture, data flow, rendering rules, and pitfall documentation.

Adding Your Own Content

You can extend DeepVault with your own notes, categories, and quizzes. The pre-loaded content stays — you're adding to it, not replacing it.

Add Notes to Existing Categories

  1. Write .md files in your Obsidian vault folder (e.g., C++ Fundamentals/My Note.md)
  2. Run python convert.py — it detects new files and rebuilds data.js
  3. Add quiz questions for your notes in js/data.js (see format below)
  4. Open index.html — your notes appear alongside the existing ones

Add a Brand New Category

  1. Create a folder in your Obsidian vault (e.g., Shaders/) and add .md notes
  2. Add one entry to FOLDER_MAP in convert.py:
    ('shaders', 'Shader Programming', 'Shaders', '🎨', '#ff6b6b'),
    Format: (id, display_name, vault_folder, icon, color)
  3. Run python convert.py — your category appears on the dashboard
  4. Add quiz questions for your notes in QUIZ_DATA inside js/data.js
  5. Run python convert.py again — it preserves your quizzes during rebuild

Quiz Format

QUIZ_DATA['My Note'] = {
  questions: [
    {
      type: "multiple_choice",
      question: "What is X?",
      options: ["Option A", "Option B", "Option C"],
      correctIndex: 1,
      explanation: "Because..."
    },
    {
      type: "text_input",
      question: "Explain Y",
      correctAnswer: "The correct answer",
      acceptableAnswers: ["alt phrasing 1", "alt phrasing 2"],
      explanation: "Because..."
    }
  ]
};
  • 2–4 options for multiple choice — don't force exactly 4
  • Every question must have an explanation
  • See SKILL.md for the complete format reference

Folder Structure (Vault)

Game Development/          ←  Your Obsidian vault root
├── Computer Systems/
│   ├── Hardware/              ← 3 subfolders: Hardware, System Software, Concurrency
├── C++ Fundamentals/
│   ├── Core Language/     ←  Subfolders → collapsible groups
│   ├── Memory & Ownership/
│   ├── OOP & Polymorphism/
│   └── Types & Data/
├── Game Math/
│   ├── Advanced/
│   └── UE Math/
├── UE Core/
├── UE Networking/
└── Big O Notation/

Contributing

See CONTRIBUTING.md for how to add quizzes, notes, or features. AI contributors: read SKILL.md first — it has 10 critical rules and every pitfall we encountered.

License

  • Code (HTML/CSS/JS/convert.py): MIT — use, modify, learn from freely
  • Content (notes, quizzes, guides): All Rights Reserved — may not be republished (see CONTENT_LICENSE.md)

Made with AI

DeepVault was built entirely with AI assistance. Every note, quiz, theme, and feature — from the markdown renderer to the collapsible folder groups — was designed, coded, and debugged through AI collaboration. The SKILL.md file documents every architectural decision and pitfall from dozens of commits of development.

Content is actively updated. New notes, quizzes, and categories are added regularly from the author's Obsidian vault. Star the repo to stay updated.

If you're contributing with AI, load SKILL.md first — it prevents the exact bugs we already solved.

Built for Mayk's vault. Source-verified against UE 5.8 engine code.

About

An interactive learning platform for mastering computers, programming, and software engineering. Pure HTML/CSS/JS — zero dependencies, zero server. Built with AI.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages