https://github.com/archer884/notes
https://github.com/archer884/notes
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/archer884/notes
- Owner: archer884
- Created: 2023-11-27T18:00:23.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-26T17:43:03.000Z (10 months ago)
- Last Synced: 2025-01-23T12:18:57.028Z (5 months ago)
- Language: Rust
- Size: 60.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Notes
For searching and viewing inline comments and definitions in markdown-formatted text files.
## What kind of notes?
Like these:
```markdown
See Spot run.
```
Or definitions like this:
```markdown
See Spot run.
```
## How does it work?
The `config` subcommand will configure the program's behavior for your current working directory. Pass it the directory containing your source files.
Notes are parsed and cached in a directory called `.tool`, found in your current working directory (the one you were using when you used the config command). However, the cache is updated each time the modified time for a source file is updated, so you shouldn't need to worry about refreshing it.