tangent/memex
1
0
Fork 0
mirror of https://github.com/TangentFoxy/memex.git synced 2024-11-22 04:54:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
37e8689fea
memex/README.md
kor 72d6cee1bf Improve README formatting.
2018-10-31 13:16:08 +13:00

3.7 KiB
Raw Blame History

Live web version here

Memex is a personal knowledge base.

A bookmarks and notes application to help with storage and overview.

Memex has two modes:

  1. website that is read-only and 'sever-less' for easy sharing
  2. standalone application for bookmark and note cataloging

Memex supports:

  • filtering
  • tags
  • images
  • notes
  • quotes
  • terms
  • links
  • author
  • files
  • projects
  • themes

To change theme simply drag a theme svg file onto the Memex app/webpage.

Theme files and more information can be found here.

Live Examples

Data

docs/content/data.ndtl

Stored in a human-readable, flat-file database called Indental which is made by Devine Lu Linvega

Settings

docs/content/settings.js

  • STATSNUMTAGS = max limit of tags to show in menu
  • STATSNUMTYPE = max limit of types to show in menu
  • WIDEGRIDITEM = allow wide entries (manually set by WIDE : true or automatic long NOTES)
  • AUTOWIDETRIGGER = automaticly wide entry if it has more QOTE entries this number
  • USEMASONRY = enable Masonry layout library usage
  • MASONRYPROGRESS = Masonry re-layout as images load (true), or only once all images complete (false)
  • GRIDITEMIDBASE = CSS name prefix
  • SHOWUPPER = toggle display of upper entry elements
  • SHOWTITLE = toggle display of entry title
  • SHOWAUTH = toggle display of entry author
  • SHOWTYPE = toggle display of entry type
  • SHOWLINK = toggle display of entry link
  • SHOWLOWER = toggle display of lower entry elements
  • SHOWTAGS = toggle display of entry tags
  • SHOWPROJ = toggle display of entry project
  • SHOWNOTE = toggle display of entry notes
  • SHOWQOTE = toggle display of entry quotes
  • SHOWTERM = toggle display of entry terms
  • SHOWDONE = toggle display of menu done (tick/cross)
  • SHOWPROG = toggle display of entry progress notes
  • SHOWIMAG = toggle display of entry image
  • SHOWFILE = toggle display of entry file
  • SHOWOVERLAY = toggle display of dark overlay on hover of image type entry

Web Development

git clone git@github.com:kormyen/memex.git
cd memex
open Memex\docs\index.html in browser

The web content is isolated in a folder to seperate it from app/Electron content.

The folder is called 'docs' so that the 'Github Pages' feature can host it, another folder name doesn't seem supported.

App Development

git clone git@github.com:kormyen/memex.git
cd memex
npm install
npm start

Dependencies

Thanks

Hamish MacDonald

Twitter · Home