I added an install.md now for setting it up locally. Does that work for you?

Nice. Tip: format it as a shell code block on markdown

Also eval adding a Dockerfile for super-rapid deploy

Thanks. I'll probably look into a dockerfile option.

Does format as a shell code block mean write it in a way that it can just be copied and pasted easily?

Github has pretty comprehensive documentation on their flavor of markdown used for formatting; Here's a direct link to the section on fenced code blocks: https://github.github.com/gfm/#fenced-code-blocks

It'll format it as monospace, and typically in a format that's easier to recognize as being code.

IIRC you can do that by gating code like this:

  '''
  code goes here
  '''

in markdown, but it's been a while.

(The spaces are necessary for HN markup, but not the markdown formatting).

Hey, by quickstart do you mean for installing it locally? Or for using it on the website?

I was about to ask the same thing, didn't realize until your answer, that it is web-based? A local offline application would be great!

(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.

It is web based. That way you can read on the computer and continue reading on the phone or any other device.

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.

I would get a lot of value out of a tool like this. I have a strong preference for a portable executable and file-based storage. Performance can be a problem with those, but I want to use my existing file management and synchronization tools as much as possible.

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.

Flask is pretty lightweight and will run under anything. Including compiling to a portable executable.

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.

Thanks for the detailed answer, starred anyway! :)