Giter Club home page Giter Club logo

notes's Introduction

Notes

A simple Zsh script to edit and manage synchronized notes (via a Git repository) on one or across many machines. See the source.

Installation

Clone the repository somewhere (e.g., ~/.src/notes) and add source $HOME/.src/notes/notes.zsh to your ~/.zshrc.

Setup

Configuration

  • Set NOTES_DIR if you want a different notes path. Default is ~/.notes.
  • Set EDITOR as your CLI text editor (if not already set).

Notes Repository

Create a Git repository at NOTES_DIR (with a default remote).

Warning: If you are planning to store sensitive information with notes do not make your notes repository public.

Usage

$ notes             # Edits the default note (e.g., ~/.notes/notes)
$ notes <note-name> # Edits <note-name>      (e.g., ~/.notes/git-tips)
$ notes ls          # Lists all notes

Synchronization will happen before (git pull) and after (auto commit and git push) each editing of any note.

Credits

Erik Nomitch: [email protected]

notes's People

Contributors

eriknomitch avatar

Stargazers

Victoria Aponte-Blizzard avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.