ravenscroftj
/
notesync
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
ravenscroftj 2024-07-25 07:56:05 +01:00
parent b5b5d021aa
commit eaa4b748a9
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,3 +1,17 @@
# notesync # notesync
NoteSync is a simple Python 3.10+ script that automates copying notes from my obsidian vault over to my quartz site to be published whilst ignoring files that are not public.
Notesync recursively walks the target directory, reads the markdown frontmatter for any `.md` files it encounters and checks for `public: true`. You can also specifically tell it to ignore certain subdirectories completely which is useful if you have directories you never want to publish.
Could Notesync have been a shell script? Yeah probably, but y'know, work with the tools you're most comfortable with.
### Installation
1. Make sure you have Python 3.10+ installed, create a virtual environment or use conda if that's your jam.
2. `pip install pdm`
3. `pdm install`
Now you can run notesync with `python -m notesync`