https://github.com/sripkunda/cammy
A GNU markdown notepad that uses natural language processing to automatically detect and add events/tasks to google calendar.
https://github.com/sripkunda/cammy
markdown markdown-editor markdown-viewer productivity productivity-tools todo todolist todolist-application
Last synced: about 2 months ago
JSON representation
A GNU markdown notepad that uses natural language processing to automatically detect and add events/tasks to google calendar.
- Host: GitHub
- URL: https://github.com/sripkunda/cammy
- Owner: sripkunda
- License: gpl-3.0
- Created: 2021-06-13T07:26:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-22T00:43:16.000Z (over 3 years ago)
- Last Synced: 2023-03-21T02:27:50.608Z (over 2 years ago)
- Topics: markdown, markdown-editor, markdown-viewer, productivity, productivity-tools, todo, todolist, todolist-application
- Language: JavaScript
- Homepage: https://sripkunda.github.io/Cammy
- Size: 679 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
Cammy is a GNU markdown notepad that detects and adds tasks/events to google calendar.
## Download
The download page for the latest Linux/OSX/Windows installation packages can be found [here](https://github.com/sripkunda/Cammy/releases).
## FAQ
### What is it?
Cammy is a free to use, open source tool that allows you to plan out your day in a notepad-like environment while allowing you to sync your most important tasks and events with google calendar.
### How does it work?
Cammy uses real-time natural language processing to identify dates, tasks, and events as you type. These dates and events are then parsed for important information, such as the title, duration, date, and time of the event/task. Once a match is found, Cammy will allow you to add a task to your calendar app with a single click.
### Why Cammy?
Unlike modern productivity tools that restrict the structure and format of your todo lists and calendars to only what is offered in the app, Cammy provides you with ultimate freedom, as if you are writing on a blank sheet of paper. This helps eliminate distractions and maintain a productive environment while working.
## Screenshots / Features
- Automatic Event Recognition
- Multiple Color Themes (Light & Dark)
- Real-time markdown editing for productive note-taking and planning
- Free and Open Source
## Using Cammy
Cammy's editor is built for simplicity. The only thing you will see on the canvas is the editor window, with no additional toolbars or dialogs.
The editor uses markdown for text formatting. You can learn about markdown and how to use it [here](https://www.markdownguide.org/). _(A bubble tooltip-based toolbar for core formatting features such as headings and bullet-points is in development.)_
### Event Highlight Colors
Regular events and tasks are highlighted in yellow. Repeating events and tasks are highlighted in orange.
### Saving and Opening Files
Cammy acts as a regular text editor, meaning that you can open, edit, and save new or existing files. The `File` menu has options to save and open files.
### Adding events to the calendar
Once Cammy recognizes a piece of text as an event, it will automatically highlight it to indicate that it can be automatically added to your calendar (unless event recognition is turned off). There are two ways to add an event to your calendar.
The first is to press Ctrl or ⌘ Shift A while on the line which has a recognized event. The second is to click on the line in the editor window.
### Color Themes & Appearance
To switch the color theme of the editor, navigate to the `Window` menu and click `Switch Color Theme`. Alternatively, press Ctrl or ⌘ Shift , on your keyboard.
### Keyboard Shortcuts
**Editor:**
| Shortcut | Action |
| ------------------------------------------------------------- | ------------------------ |
| Ctrl or ⌘ O | Open File |
| Ctrl or ⌘ S | Save Current File |
| Ctrl or ⌘ Shift S | Save Current File As |
| Ctrl or ⌘ Shift A | Add to calendar |
| Ctrl or ⌘ Shift . | Toggle Event Recognition |
| Ctrl or ⌘ Shift , | Switch Editor Theme |
**Markdown:**
| Shortcut | Action |
| ------------------------------------------------------------- | ----------------- |
| Ctrl or ⌘ B | Bold |
| Ctrl or ⌘ I | Italic |
| Shift Ctrl or ⌘ H | Large Heading |
| Ctrl or ⌘ H | Small Heading |
| Ctrl or ⌘ - | Block Quote |
| Ctrl or ⌘ K | Insert Link |
| Ctrl or ⌘ L | Unordered List |
| Ctrl or ⌘ Alt C | Insert Code Block |
## Credits
This project would not be possible without [EasyMDE](https://github.com/Ionaru/easy-markdown-editor), the core of the markdown editor that has been modified to fit the editing needs of Cammy's real-time markdown-preview. Cammy also uses [compromise](https://github.com/spencermountain/compromise) for natural language processing (how Cammy recognizes events, tasks, dates, etc.).