Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elnook/notedo
Notes, Todos, Markdown, Bookmarks and more with VIM support and full-text search - stay'in organized
https://github.com/elnook/notedo
Last synced: 3 months ago
JSON representation
Notes, Todos, Markdown, Bookmarks and more with VIM support and full-text search - stay'in organized
- Host: GitHub
- URL: https://github.com/elnook/notedo
- Owner: elnook
- Created: 2020-11-17T07:24:40.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-08T01:29:07.000Z (6 months ago)
- Last Synced: 2024-06-16T15:42:00.958Z (5 months ago)
- Homepage:
- Size: 767 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Notedo
- Write Notes in [markdown](https://en.wikipedia.org/wiki/Markdown), attach Todos and Images to your notes
- Keep links/bookmarks organized and accessible
- Fast full text search with instant indexing
- Vim mode _(because Vim > Emacs)_
- Accessible as a [single page app](https://en.wikipedia.org/wiki/Single-page_application) and a [Progressive Web App (PWA)](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps) for a native experience
- All connections stay local with zero external dependencies
- Works equally on Linux, Mac, and Windows
- No install required - distributed as a portable self contained executable
- and more...
Notedo is in early development, see [roadmap](https://github.com/elnook/notedo-roadmap) for upcoming features. Feel free to request a new feature or report a bug under [issues](https://github.com/elnook/notedo/issues)
## Usage
Download the [latest release](https://github.com/elnook/notedo/releases/tag/0.4.1-1-gb87edb7) and launch the server
```
notedo server --gui
```
Contextual help is available with `notedo help`
## Config
Settings can be overridden by CLI flags, environment variables, and the config file (in that order)
e.g. to launch with a different host and port:
```
notedo server --host 0.0.0.0 -p 8080
```
The flag names resemble the equivalent environment variable and config file settings
For example,
```
$ notedo help
...
Flags:
-d, --datadir string Data storage path ...
...
```
To override datadir you can set the environment variable `NOTEDO_DATADIR=` or in the `notedo.yaml`:
```yaml
datadir:
```
See the contextual help for additional instructions on modifying settings
## Tips
- `Ctrl+P` (`Command+P`) to focus search field
- `Ctrl+Shift+L` (`Command+Shift+L`) to focus search field in `link` mode
- Search supports `slash commands`, start search with `/`
- Search queries use Bleve's [Query String Syntax](http://blevesearch.com/docs/Query-String-Query/), few examples:
- `note` will find instances of `note`, `Note`, `notes`, `Notes`, etc.
- `note*` will find the same but also non-stemmed words, such as `Notedo`
- Use the bookmarklet for quickly saving links
- Pin notes by dragging to left nav
## Tech
- Back-end written in [Go](https://golang.org/)
- Front-end written using [Vue.js](https://vuejs.org/) with dist embedded into executable
- Files (markdown, images, etc.) are stored on disk as is
- Metadata is stored in a [boltdb](https://github.com/etcd-io/bbolt) on disk