Also a short "Quick start guide" on the README would be nice...IU was unable to find out an INSTALL.md either.
Also eval adding a Dockerfile for super-rapid deploy
Does format as a shell code block mean write it in a way that it can just be copied and pasted easily?
IIRC you can do that by gating code like this:
'''
code goes here
'''
(The spaces are necessary for HN markup, but not the markdown formatting).
(also maybe.. is making an account necessary?)
And one more question, can it also pull multi-page documentation, or just single URL's? I assume it downloads websites and makes them offline available, or is that a wrong assumption.
A version that runs just locally on the computer would also work, but that wasn't the main focus of this particular iteration.
I haven't built a robust offline functionality yet. That's something I'm thinking of doing in the near future. Was thinking of having your X most recent articles cached.
It parses the content of articles and stores the text in a db. Then as you highlight and add notes, the text gets updated with the annotations.
It doesn't pull multipage documentation. Each url should be added manually.
At least for now.
If that's not possible, than my second preference is a docker-based deployment on Unraid. That's the easiest way for me to self-host. Nice to be able to point to an existing DB for that too.
I mean, potentially.
I'm 100% with you on file-based storage and flexible storage interchange APIs. I have a bunch of stuff I'd like this kind of tool to interoperate with.