Skip to content

LudeeD/nota

Repository files navigation

NOTA

NOTA is a simple note taker tool that helps you organize your notes.

Why Another tool ? Aren't there enough already ?

Yeah, there are and that is part of the problem NOTA aims to fix. I wanted to write my notes like I like to write my code: with no predefined editor, only tooling around the language. I wanted to be this way for my notes too, I wanted to be able to edit and take notes with any editor I wanted. No app lock in's no enforced programs or shaddy web apps to use to do the things I wanted.

Simple text files, with a litle bit of tooling around for the extra producivity

Very early state in the project, not ready in any way shape or form xD

Features

  • Basic note management (create, update list, search)
  • Linking and Reverse Linking of notes
  • Export to other formats

Install

  • Download the binary
  • Add it to your path
  • Create a folder for your notes (optional)
  • Add a Environment Variable NOTA_FOLDER that points to the folder
  • You are good to go !

API

  • nota init

    • initializes the NOTA folders
    • Status: Buggy
  • nota list

    • list available notas
    • Status: TODO
  • nota new NAME

    • NAME is optional
    • if NAME is provided use it to create nota
    • if not create a new one under Daily/
    • Status: Buggy
  • nota add PATH

    • PATH is required
    • adds an existing markdown file to the nota folder
    • storing their metadata in the nota index
    • Status: Buggy
  • nota update NAME

    • updates the NOTA by adding their metadata to the index
    • Status: TODO
  • nota export NAME

    • NAME is optional
    • exports the nota into the specific format, right now HTML
    • Status: Buggy