Skip to content

rzigante/researchfolio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Researchfolio

Researchfolio cover

Researchfolio turns a folder of Markdown research notes into a clean index, JSON dataset, command-line search, and static HTML dashboard.

It is useful when your research lives in loose Markdown files and you want a quick way to see titles, dates, tags, links, topics, summaries, and reading weight without moving everything into a heavier knowledge-base app.

Dashboard screenshot

Features

  • Scan nested Markdown folders with zero runtime dependencies.
  • Extract titles, dates, tags, headings, links, summaries, word counts, and reading time.
  • Export the collection as Markdown or JSON.
  • Generate a self-contained static dashboard with search and tag filters.
  • Search locally from the CLI.
  • Works with ordinary Markdown files and front matter.

Quickstart

python -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
researchfolio scan examples/notes --format markdown
researchfolio dashboard examples/notes --output demo/index.html --title "Demo Research Vault"

Open the generated dashboard:

python -m http.server --directory demo 8765

Then visit http://localhost:8765.

CLI

Create a Markdown index:

researchfolio scan ~/research-notes --format markdown --output INDEX.md

Create a JSON index:

researchfolio scan ~/research-notes --format json --output researchfolio.json

Search metadata:

researchfolio search ~/research-notes "privacy pricing"

Generate a static dashboard:

researchfolio dashboard ~/research-notes --output site/index.html --title "Research Vault"

Markdown Metadata

Researchfolio supports lightweight front matter:

---
title: Privacy Pricing Benchmarks
date: 2026-05-31
tags: [privacy, pricing, research]
---

# Privacy Pricing Benchmarks

Short summary paragraph here.

If there is no date field, Researchfolio tries to infer YYYY-MM-DD from the filename.

Development

python -m pip install -e ".[dev]"
pytest
ruff check .

Project Scope

This is a compact, honest MVP: it does deterministic extraction from local Markdown and does not call an AI model. That makes the outputs predictable, cheap, and easy to run in CI.

License

MIT

About

Turn Markdown research notes into a searchable index and static dashboard.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages