Getting Started

Installation

The latest binaries are available on the releases page.

On Mac/Linux you can install the binary with:

curl -L https://github.com/marcusleonas/notebutler/releases/latest/download/<version>.tgz -o notebutler

install notebtler /usr/local/bin

On windows, you can download the binary from the releases page and add it to your PATH.

Initialising a new notebook is as simple as running:

notebutler init

Make sure to fill in all the fields otherwise the notebook will not be created.

To create a new note, run:

notebutler new

Once again, fill in all the fields. This time, the fields can be filled using flags.

Available flags:

-n, --name: Name of the note.

-t, --template: Template to use for the note (found inside .notebutler/templates). Do not include the .md extension. Defaults to default.

-o, --open: Open the file in the default editor after creation. Defaults to false.

Reading a note renders it using glamour and outputs it to stdout.

notebuter read <name>

To build your notes to a static html site, run:

notebutler build

This will create a html directory in the current directory, with all your notes converted to html. This includes picocss for styling.

To serve your notes for local development, run:

notebutler serve

This will start a local server on port 8080.

If you have any issues or feature requests, please open an issue on the issues page. I'm open to any suggestions and contributions.

Licensed under the MIT License.