Code Monkey home page Code Monkey logo

memex's Introduction

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

Web Development

git clone [email protected]: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 [email protected]: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
LOADANIMNUM threshold number of articles in query/displayed to trigger loading animation to display
WIDEARTICLE allow wide entries (WIDE : true)
AUTOWIDETRIGGER automatically 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)
ARTICLEIDBASE 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

Thanks


Hamish MacDonald

Twitter · Home

memex's People

Contributors

joshavanier avatar kormyen avatar lcb931023 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.