Skip to content

A lightweight, super-simple, flatfile-based bookmark app

Notifications You must be signed in to change notification settings

philcoffeejunkie/flatmark

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 

Repository files navigation

flatmark

A lightweight, super-simple, flatfile-based bookmark app

Format Specification

The core of flatmark is a plaintext file containing all bookmarks. The format is inspired by successful and simple formats like todo.txt — a bookmark is one line in the file consisting of three parts:

  • the link itself, starting with the protocol string (mandatory)
  • a description in parentheses (optional)
  • tags for later filtering, indicated by the hash-sign (optional)

A simple example would look like this:

https://www.github.com (Optional description) #some #optional #tags

I want to encourage everybody to write your own app for whatever platform to handle flatmark bookmarks!

Implementation

As I could not find a bookmarking solution that I really liked I started to keep my bookmarks in a simple text file (see above). Soon after I hacked together a first approach to manage this file with a simple web app (see the legacy branch).

Finally I re-implemented the whole thing using NodeJS and ExpressJS to learn something new.

Planned Features (TODO)

  • Deleting bookmarks
  • Add some CSS to make the webapp look nice
  • Edit bookmarks
  • Export/Import functionality for the whole bookmark-file
  • Provide authentication

License

MIT License

Copyright (c) 2016 philcoffeejunkie

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A lightweight, super-simple, flatfile-based bookmark app

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published