Skip to content
forked from hanebox/ekphos

A lightweight, fast, terminal-based markdown research tool inspired by Obsidian

License

Notifications You must be signed in to change notification settings

calendar0917/ekphos

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ekphos

Crates.io Rust License

An open source, lightweight, fast, terminal-based markdown research tool built with Rust.

Ekphos Preview

Documentation

Full documentation has moved to docs.ekphos.xyz

Quick Start

cargo install ekphos

Note: Always update to the latest version. If you encounter config issues after updating, run ekphos --reset to reset your configuration.

Requirements

  • Rust 1.70+
  • For inline images: iTerm2, Kitty, WezTerm, Ghostty, or Sixel-compatible terminal

Contributing

git clone https://github.com/hanebox/ekphos.git
cd ekphos
make run
  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes
  4. Submit a PR to the main branch

To contribute to the documentation, see ekphos-docs.

Disclaimer

This project is in early development. There may be breaking changes and bugs in pre-releases.

License

MIT

About

A lightweight, fast, terminal-based markdown research tool inspired by Obsidian

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 98.8%
  • Other 1.2%