Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jonmagic/nvatom-package


https://github.com/jonmagic/nvatom-package

Last synced: 30 days ago
JSON representation

Awesome Lists containing this project

README

        

# nvatom

**This is a work in progress, features described aren't necessarily implemented yet.**

This Atom package is all about taking notes and then using what you've written. From journal entries, to emails, to lists, nvatom makes writing and using your notes simple and fast.

Navigate your notes like you surf the web. The search bar at the top is universal search for your notes and the search results are displayed instantly with each key press.

Create rich notes with Markdown and take things a step further with GitHub Flavored Markdown and features like Task Lists. View your rendered note in realtime as you type or toggle between edit and view modes.

Selectively publish notes as public or private [Gists](https://gist.github.com).

nvatom was inspired by [Notational Velocity](http://notational.net) and [nvALT](http://brettterpstra.com/projects/nvalt/) and is built on top of [Atom](https://atom.io).

## TODO

- [x] build model for storing, listing, and searching documents
- [x] watch path for file changes
- [ ] build html/css layout (search/create, list, editor)
- [ ] live update document list when files update
- [ ] use Atom editor for editing files

## Demo From [Previous Attempt](https://github.com/jonmagic/noton)

![demo](http://cl.ly/image/0c0D0K351E45/Screen%20Recording%202014-12-07%20at%2007.27%20AM.gif)

## Installation

coming soon

## Contribution

Fork the repository, make some changes, and submit a pull request so we can start a conversation.

## License

The MIT License (MIT)

Copyright (c) 2014 Jonathan Hoyt

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.