Skip to content

Rishan22/NotesGraph

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Obsidian Notes Graph

This tool automates building a knowledge base for quick learning or creating a reference guide. It fetches GitHub READMEs, adapts them for Obsidian, enabling users to visualise a topic and related fields using Obsidian's graph view.

To-Do

  • Expand to include plugins for additional websites.
  • Enhance the reformatting process for Obsidian.
  • Integrate a LLM for data cleaning, analyzing/summarising notes.

Features

  • Fetches and reformats README files from GitHub for Obsidian compatibility.
  • Utilizes environment variables for secure API key management.

Prerequisites

  • Node.js.
  • A GitHub API key with repository access permissions.

Setup

  1. Clone this repository.
  2. Install dependencies with npm install.
  3. Create a .env file in the project's root, adding GITHUB_API_KEY=your_api_key_here.
  4. List the repositories in index.js (const repoUrls = "[URL,URL2,...]").
  5. Execute the script with the commands:
node index.js

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published