github.com/jacekolszak/noteo@v0.5.0/README.md (about)

     1  Noteo is a command line note-taking assistant which can be helpful in all 3 stages of note-taking:
     2  
     3  * brainstorming (quickly adding notes)
     4  * reviewing and refining notes (tagging, organizing notes in folders)
     5  * searching for notes (using advanced filtering and sorting)
     6  
     7  ## Installation
     8  
     9  Download the [release archive](https://github.com/jacekolszak/noteo/releases) and extract the binary to your `bin` folder.
    10  
    11  If your OS/arch is not available you can try to build it manually using [Go](https://golang.org/):
    12  
    13  ```bash
    14  go get -u github.com/jacekolszak/noteo
    15  ```
    16  
    17  ## Demo
    18  
    19  ![Demo](demo/demo.gif)
    20  
    21  ## File format
    22  
    23  Each note is a file in standard [Markdown](https://en.wikipedia.org/wiki/Markdown) format with meta information provided in the beginning of the file in the form of [YAML front matter](https://jekyllrb.com/docs/front-matter/)
    24  
    25  ```md
    26  ---
    27  Created: Sat Sep  5 12:30:05 CEST 2020
    28  Tags: space separated tags
    29  ---
    30  
    31  Some Markdown content here.
    32  ```
    33  
    34  Noteo extracts information from this header to filter out and sort notes. Some commands such as `tag set` and `tag rm` may update the header too. If the YAML front matter is missing, Noteo uses default values such as empty `Tags` or `Created` equal to file modification date.
    35  
    36  ### Tag format
    37  
    38  Each tag is a string without whitespaces (space, tab, new line), for example `idea`, `task`
    39  
    40  Tag might have a special form of `name:value`, for example `deadline:2020-09-30` or `priority:1`. Value can be a date or integer.