Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
 
 
 
 
 
 
 
 
 
 

README.md

headcache

headcache is a note program written in Python(3) and PyQt (5).

It's based on normal markdown files as notes, uses no database or program-specific format and renders the markdown instantly.

headcache was designed to have a minimal and intuitive interface, for quick navigation and instant search.

example

installation and use

Install with

pip install headcache

and run it in a directory of your choice with headcache from the command line (or an appropriate shortcut). It looks for .md files in the working directory that have one h1 headline, and splits the content of each file in h2 chunks.

markdown_syntax

Since text editing is a very personal choice, headcache does not contain a text editor! To add or change your notes, use an external editor. File changes are instantly loaded into the program. A double click on any file will open it in the default text editor. Saving will trigger an instant update to navigation, preview and the search index.

The escape key can be used to quickly jump to search (and back). All file contents are indexed, searches are instant and a return key press on any match will jump to the appropriate information.

search

The search index is being kept up to date with file changes. Initial indexing at program start may take a second or so, but is done on a separate thread and doesn't block the main program.

search

Navigation between search bar, file list, part list and preview can also be done with tab/shift-tab. A tiny red line at the bottom of each pane indicates the current focus.

search

All the usual markdown is supported, including tables and images. Links are opened in the default system browser.

headcache writes a headcache_config.json on exit that can be edited. search_text_weight and search_title_weight set the relative search weights for body and title of the markdown files. A big title weight will push search matches in the title higher up.

todo

  • new file dialog
  • handle file renames
  • icon, some styling (light theme?)
  • tag support?
  • better context for search matches
  • LaTeX support?
  • maybe reuse search index

About

small and fast note program written in Python

Resources

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.