https://github.com/maxmx03/nt
Nt is a lightweight command-line tool designed to help you create, organize, and manage your Markdown notes effortlessly.
https://github.com/maxmx03/nt
Last synced: 11 months ago
JSON representation
Nt is a lightweight command-line tool designed to help you create, organize, and manage your Markdown notes effortlessly.
- Host: GitHub
- URL: https://github.com/maxmx03/nt
- Owner: maxmx03
- License: mit
- Created: 2024-08-14T00:47:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-28T10:38:20.000Z (over 1 year ago)
- Last Synced: 2024-11-11T11:48:52.364Z (about 1 year ago)
- Language: Shell
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notes
> [!CAUTION]
> This script is intended for personal use, Use it at your own risk.
This script helps you create and organize your Markdown notes with ease.
## Dependencies
Make sure you have the following dependency installed:
```go
go install github.com/charmbracelet/gum@latest
```
## Installation
To install the script, add it your shell configuration
```bash
echo "source /path/to/notes.sh" >> $HOME/.bashrc
```
## Usage
Creating a new note is straightforward. Just use the `nt` command:
```bash
# This will open a prompt for you to input the folder and filename
# Example: projects/project1/notes.md
nt create
```
> [!NOTE]
> By default, the script opens Neovim as your editor. If you'd prefer to use a
different editor, you can easily change this by setting the `$EDITOR` variable
## Additional Commands
To explore more commands and options, use:
```bash
nt help
```
## Contributing
If you encounter any issues or have suggestions for improvements, feel free to
contribute by submitting a pull request or opening an issue.