
install-learning-graph-viewer
by dmccreary
SKILL.md
name: install-learning-graph-viewer description: This skill installs an interactive learning graph viewer application into an intelligent textbook project. Use this skill when working with a textbook that has a learning-graph.json file and needs a visual, interactive graph exploration tool with search, filtering, and statistics capabilities.
Install Learning Graph Viewer
Overview
This skill installs a complete interactive graph visualization application into the /docs/sims/graph-viewer/ directory of an intelligent textbook project. The viewer provides an interactive way to explore learning graphs with features like node search, category filtering, and real-time statistics.
When to Use This Skill
Use this skill when:
- A learning graph has been generated (learning-graph.json exists in /docs/learning-graph/)
- The textbook needs an interactive visualization tool for exploring concept dependencies
- Students or instructors need to filter, search, and analyze the learning graph structure
Prerequisites:
/docs/learning-graph/learning-graph.jsonmust exist- The JSON file must have metadata with a
titlefield - MkDocs project structure must be in place
Installation Workflow
Step 1: Verify Prerequisites
Before installation, verify that the learning graph JSON file exists:
ls /docs/learning-graph/learning-graph.json
If the file doesn't exist, use the learning-graph-generator skill first to create the learning graph.
Step 2: Create Directory Structure
Create the graph-viewer directory:
mkdir -p /docs/sims/graph-viewer
Step 3: Install Viewer Files
Copy the four essential files from the skill's assets directory to the target location:
cp assets/main.html /docs/sims/graph-viewer/main.html
cp assets/script.js /docs/sims/graph-viewer/script.js
cp assets/local.css /docs/sims/graph-viewer/local.css
cp assets/index.md /docs/sims/graph-viewer/index.md
Step 4: Extract Title from Learning Graph JSON
Read the title from the learning graph metadata:
# Use Python or jq to extract the title
python3 -c "import json; data = json.load(open('/docs/learning-graph/learning-graph.json')); print(data.get('metadata', {}).get('title', 'Learning Graph'))"
If the metadata or title field doesn't exist, use a default title like "Learning Graph" or the course name.
Step 5: Update Title in main.html
Replace the "TITLE" placeholder in main.html with the extracted title:
- Read the extracted title from Step 4
- In
/docs/sims/graph-viewer/main.html, replace all instances of "TITLE" with the actual course title - This appears in two locations:
- The
<title>tag:<title>Learning Graph Viewer for TITLE</title> - The page heading:
<h4>Learning Graph for TITLE</h4>
- The
Step 6: Update MkDocs Navigation (Optional)
If the user wants the graph viewer in the site navigation, add it to mkdocs.yml:
nav:
- MicroSims:
- List of MicroSims: sims/index.md
- Graph Viewer: sims/graph-viewer/index.md
Step 7: Inform the User
Provide the user with instructions to test the installation:
- Run
mkdocs serveto start the local development server - Navigate to the appropriate URL based on their repository name:
- Format:
http://localhost:8000/REPO_NAME/sims/graph-viewer/main.html - The REPO_NAME can be extracted from the git repository or inferred from the project structure
- Format:
- Alternatively, if added to navigation, they can access it through the MkDocs site menu
Viewer Features
The installed graph viewer provides:
Search Functionality:
- Type-ahead search with dropdown results
- Shows category information for each node
- Focuses and selects matching nodes in the visualization
Category Filtering:
- Sidebar legend with color-coded categories
- Checkboxes to show/hide specific taxonomy groups
- "Check All" and "Uncheck All" bulk operations
- Collapsible sidebar for expanded viewing
Real-time Statistics:
- Visible node count
- Visible edge count
- Orphaned node count (concepts with no dependencies)
Interactive Visualization:
- vis.js network graph with physics simulation
- Color-coded nodes by taxonomy category
- Directed edges showing concept dependencies
- Zoomable and draggable interface
Technical Details
File Structure:
/docs/sims/graph-viewer/
├── main.html # Main application HTML
├── script.js # JavaScript logic for visualization
├── local.css # Styling for the viewer
└── index.md # Documentation page with iframe embed
Dependencies:
- vis-network.js (loaded from CDN in main.html)
- learning-graph.json (loaded from ../../learning-graph/learning-graph.json)
Data Path:
The script.js file loads the learning graph from a relative path: ../../learning-graph/learning-graph.json. This assumes the standard intelligent textbook structure where /docs/sims/ and /docs/learning-graph/ are siblings.
Resources
assets/
This skill includes four asset files that get copied to the target directory:
- main.html - The main viewer application HTML file with vis-network integration
- script.js - Interactive JavaScript for search, filtering, and visualization
- local.css - Stylesheet for the viewer interface
- index.md - Documentation page explaining the viewer features
These files are templates from the learning-graphs repository and are ready to use without modification (except for the TITLE placeholder in main.html).
スコア
総合スコア
リポジトリの品質指標に基づく評価
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
3ヶ月以内に更新がある
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
レビュー
レビュー機能は近日公開予定です