Repository plan

[Rokt33r]

Repository plan

User will be able to select any folder to use as a note repository from v0.6.*.
It has been designed to be handled by Git properly.

root
 |- data
     |-note1.cson
     |-note2.cson
     |-note3.cson
 |- boostrepo.json

boostrepo.json

{
  name: String,
  author: String, // Same convention of package.json, `John Doe <email@example.com> (http://example.com)`
  remotes: [{
    name: String,
    url: String, // url of git remote
    branch: String // if branch isn't set, it will try to use `master` branch.
  }],
  folders: [{
    key: String // Unique sha1 hash key to identify folder,
    name: String,
    color: String // All CSS color formats available.
  }]
}

data directory

Every note will be saved here as a single CSON file to git diff efficiently.

This is because CSON supports Multiline string.

File name of each cson file will be used to identify note.
Commonly, Boostnote will automatically generate sha1 key and use it as a file name when creating a new note.

note.cson

name: String
tags: [String] // tags
folder: String // hash key of folder
mode: String // syntax mode
title: String
content: String
createdAt: Date
updatedAt: Date

[Rokt33r]

For further information check the comment of https://github.com/BoostIO/Boostnote/blob/0.6.0/browser/lib/Repository.js

[Rokt33r]

Canceled