memex/README.md

Memex is a personal knowledge base.

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

Live web version here

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.

Data

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

• docs/content/data.ndtl

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
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

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

Thanks

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

---

Hamish MacDonald

Twitter · Home