Probably a bit overkill for a simple blog, but it should be evaluated whenever someone is looking for a end-user friendly doc generator.
It seems the main point of Code Notes is to serve a static site, but I'd love to see the author turn it into an editor by hooking up a ProseMirror [2] instance :)
Out of curiosity, what solutions do others use for tags/categorization/full-text search of their notes? Code Notes seems to use FlexSearch.js [1].
[1]: https://github.com/nextapps-de/flexsearch [2]: https://prosemirror.net/
[1]: https://fusejs.io/
In our app, we have a dynamic flexsearch index for full text search, and support for filtering by tags in multiple ways while also doing full text search.
There are 3 techniques for categorizing. One, called contexts, is like a separate notebook. Tags and note data are totally separate from each other in each context. Within a context you have mentions (for people) and topics. Topics support heirarchy, so you can have Projects as well as projects/NoteBrook, as deeply nested as you want, and you can search for any level of nesting.
The search engine then supports full text search along with AND for tags at the same time.
If you register for an account, you also get instant sync to all your devices.
A new version is coming out this weekend, we’re still in alpha. The next version will have note favoriting, deleting, and editing, along with some better workflow for nested tags. We expect to launch the Beta in June with apps on every major platform (desktop and mobile).
If you have a chance to give us a try, please let us know how you like it! https://NoteBrook.app and the early access code is ALPHA2020. Email us at hello at NoteBrook.com
Other than tags/search, one thing that is very important to me is "first-class" math support, where I can enter LaTeX math notation that renders inline, but which behaves like text whenever the cursor enters the math block. In general, I always appreciate when editors locally "act like" a plain text file near the cursor, but abstract away all the markup wherever I'm not directly editing. Two editors that get this right are Typora (inline-level editing) and Jupyter notebooks (block-level editing).
I agree that ProseMirror has a steep learning curve, and there aren't currently enough open-source extensions available. Hopefully, with time, enough standard components will emerge. In the future, I hope to see a ProseMirror-backed drop-in Markdown editor become the default for browser-based editing.
ProseMirror doesn't currently have standard support for wysiwyg-math, but I've recently been working to change that [1]:
[1]: proof of concept: https://codesandbox.io/s/quizzical-austin-m7n3t?file=/src/in...
I have a a google doc called “unix commands” that I just add stuff onto. It started as a text file in my home directory 30 years ago and has grown to pretty much any snippet of code.
I control+F to find stuff and that works ok. I’m not sure the level of effort to reformat to this theme would pay off in benefits of easier search and reuse.
- How quickly can I create/update/delete
- How easily can I search and read
I love how you have solved the second part. I have to ask, how do you handle the first part?
Do you keep one editor always open to quickly edit the markdown files?
To add a alternative: Docsify
It's not optimized for notes(tags are missing), but it does offer a large amount of community addons: https://docsify.js.org/#/awesome
git clone git@github.com:MrMartineau/gatsby-starter-code-notes.git code-notes
git clone https://github.com/MrMartineau/gatsby-starter-code-notesIt's not that elaborate, but I found it the best solution for cross platform and cross-location.
I can access it everywhere and edit it from everywhere, where I have a IDE available.
I like a 1 for all solution more then specific tools, like the specialized cheatsheet CLI tools - it gets messy after a while...
Anything I find my self Googling how to do (git remove merged branches from origin), I create an easy command for.
Respect to those who do it and it works for them though.
Email us at hello at NoteBrook dot com if you want to be on the mailing list. New version launching this weekend with favoriting, deleting, and editing support. Beta out by end of month with apps on every major platform.
We are obsessed in our design with making everything as fast and streamlined as possible. For example, deleting notes is similar to gmail where it instant deletes instead of showing you a modal of “are you sure?”, but gives you an “undo” snack bar at the bottom if you didn’t mean to delete it, and you can search and find the note later with a deleted note filter if you ever do want to undelete it later. There is not a separate “note list” view, you can always see the full text of recent notes and can search filter all from a single page. Our entire side menu is just signup/login/sign out right now, everything else about the app is driven from the main UI!
Please give it a try and let us know what you think we should add next. Right now, we’re planning on adding image and file upload, markdown and code support, and full screen editors after we launch the beta with apps.
It has a built in search, I dont know how good it is tough.
I edit it in my IDE. It's always in my "recent project tab" and I have the IDE open anytime I use or want to edit the notes anyway.
It doesn't need a special note-app, which makes it even easier to use it anywhere. docsify has a "edit on github"-addon, which would make it easy to even edit it in the browser.
The notes are all markdown which is exceedingly good for code notes, with the code blocks and highlighting. And quick to pick up.
Combine with Typora for a pretty UI for your editor and you have multi-device synced notes without vendor lock-in for free.
The Android app is usable but could be a little better. Desktop is solid.
That said, if you put it up on a website and add a short blurb, search engines can come index it, and others may be able to find and use it.
Sometimes my search ends up on a Github Gist, which will often have a bit of discussion in the comments as well.
Would a good workflow be to type a hot key to pop open a full screen editor for the math notation, like how the # or @ work when typed? Perhaps with a live preview as you type?
What would be a reasonable key to trigger that, is there a standard trigger key for math like there is @ for people and # for hashtags?
$$
\int_a^b f'(x) dx = f(b)-f(a)
$$
The next best thing would definitely be a popup! A natural toggle button would be $, though it may make more sense to only insert math on a quick double-tap of $, so users can still write about money :). Assigning it to CTRL+4 or similar might also be a good compromise.