Giter VIP home page Giter VIP logo

jot's Introduction

Jot

A Zettelkasten CLI helper written in Go

Welcome to Jot

When Jot is ran without any additional arguments, it will open Neovim inside the ~/notes directory. To quickly create a new note, the executable can be run using all additional arguments as the title. A note is then created using the following template and opened in Neovim:

---
title: This Is A Zettel Title
date: 06/27/2024 02:30 AM
tags:
---

# This Is A Zettel Title

Configuration

You can create ~/.config/jot/config.yaml in order to adjust Jot how you like.

NotesDir: "/home/user/notes"
Editor: "nvim"
Template: "---\ntitle: $title\ndate: $date\ntags:\n---\n\n# $title"

Configuration Options:

NotesDir: The directory for your notes

Editor: The command to launch your editor (ie nvim not neovim)

Template: The template to use when creating a new note (use $date and $title if you wish to include those)

This project is created to help with the Zettelkasten method, but it does not have to be used solely for that purpose. However, I don't plan on adding anything more than needed to help with that method. This will hopefully keep the project fairly simple and focused.

If you're wondering what the heck is a Zettelkasten, you can learn more about it here:

Zettelkasten Introduction

jot's People

Contributors

grapeofwrath avatar

Watchers

 avatar

jot's Issues

Feat: Figure out if I want to use flags

Could be useful for:

  • showing current version
  • accessing different variables

I believe I would need to change stuff with os.Args to flag.Args in order for it to work correctly.

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.