-
-
Notifications
You must be signed in to change notification settings - Fork 58
Home
Welcome to the flatnotes wiki!
There is no database, only a single folder of markdown files (and the .flatnotes sub-folder).
This stores a full text index of your note content allowing for rapid search times.
As long as flatnotes isn't running, sure! It'll just get rebuilt then next time flatnotes is run.
Yup. The only thing flatnotes caches is the search index and that's synced on every search (and when flatnotes first starts).
Yes! See the Advanced Searching wiki page.
They're just markdown files. You're free to just move the files elsewhere and use another app.
Yes. The docs are available at the /docs endpoint. See demo.flatnotes.io/docs as an example.
The first option is to choose not to. This frees you from the burden of organisation. You can then rely on flatnotes' powerful search functionality to find the note you are looking for.
Additionally, you are able to tag notes by using a hashtag anywhere in the note content e.g. #work. Tags are indexed separately from the rest of the content and so can be searched separately either by using the field prefix e.g. "tags:work" or using the hashtag shortcut e.g. "#work".
There are 4 types:
- None = No authentication, the site is open to anyone with access.
- Read Only = As above but note creation, modification and deletion is disabled. Useful if you want to use flatnotes as a blog or for documentation.
- Password = The site is protected by a username and password.
- TOTP = In addition to a username and password, the site is also protected by a time-based one-time-password.
See the Environment Variables article in the wiki for more information.
Is there a mode whereby notes can be read by anyone but only created, modified or deleted by an authenticated user?
There isn't a single authentication mode for this but there's nothing stopping you from running 2 instances of flatnotes on the same directory of notes. One could be in Password/TOTP mode and the other in Read Only mode.
flatnotes will store all new notes with the extension .md. For any existing files to be picked up by flatnotes they also need to use the extension .md. See #50 for further detail.
The easiest way is to use wikilink-styled links. To do this simply reference the note name in double square brackets e.g. [[My Note]] will render a link to a note called "My Note".