memory.journal

A simple and lightweight journaling app.

Table of Contents

• Features
• Installation
• Roadmap
• Development
• License

Features

• Simple and easy to use interface.
• Unlimited number of journals.
• Password protection to keep memories safe.
• Unlimited number of entries/memories.
• Markdown support for formatting entries/memories.
• Runs offline and keeps your journals private.

Installation

The package should soon be available on PyPI. For now, you can install directly from the repository with pip.

pip install "memory.journal @ git+https://github.com/shsiddhant/memory.journal.git"

memoryjournal # Run the app

Roadmap

• User friendly installation and use.
• Media attachments
• Export to PDF and DayOne/Journey.cloud formats
• Markdown preview while adding/editing memories
• Markdown extensions (https://facelessuser.github.io/pymdown-extensions/)
  • strikethrough
  • highlight
  • checklists
  • syntax highlighting
  • LaTeX

Development

If you'd like to explore, improve, fix something, report bugs, or suggest any feature ideas, you are welcome to contribute.

To get started, you can have a look at the issue tracker. If you want to report a bug or make a feature request, please open a new issue using an appropriate template.

See CONTRIBUTING for a detailed overview of the contributing guidelines.

License