memex/README.md

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 webpage or app.

More information on themes can be found here.

Live Examples

• Kormyen's Memex - this repo
• Shinestrength's Portfolio - repo
• Dotcli's Memex - repo

Web Development

git clone git@github.com:kormyen/memex.git

Then open memex/docs/index.html in any web browser.

The web content is isolated in a folder to seperate it from Electron (app-building) files.

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

Data

memex/docs/content/data.ndtl

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

Settings

memex/docs/content/settings.js

Setting	Description
STATSNUMTAGS	max limit of tags to show in menu
STATSNUMTYPE	max limit of types to show in menu
WIDEGRIDITEM	allow wide entries (WIDE : true)
AUTOWIDETRIGGER	automaticly wide entry if it has more QOTE entries than 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 element(s)
SHOWTITLE	toggle display of entry title
SHOWAUTH	toggle display of entry author(s)
SHOWTYPE	toggle display of entry type(s)
SHOWLINK	toggle display of entry link(s)
SHOWLOWER	toggle display of lower entry element(s)
SHOWTAGS	toggle display of entry tag(s)
SHOWPROJ	toggle display of entry project(s)
SHOWNOTE	toggle display of entry notes
SHOWQOTE	toggle display of entry quote(s)
SHOWTERM	toggle display of entry term(s)
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(s)
SHOWOVERLAY	toggle display of dark overlay shown when hovering image type entries to improve text readability

Dependencies

• Database parser: Indental
• Template parser: Runic
• Theming: Themes
• Grid layout: Masonry
• App builder: Electron

Thanks

• Devine Lu Linvega (Oscean)
• Rekka Bell (kokorobot)
• Hundred Rabbits (Ecosystem)
• Josh Avanier (Log)
• Alexey Botkov (Legacy)
• Seena Burns (Isolate)

---

Hamish MacDonald

Twitter · Home