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
Bookmarks & notes. https://tangentfoxy.github.io/memex/
213 Commits 2 Branches 0 Tags 36 MiB
JavaScript 69.9%
CSS 27.1%
HTML 3%
359d3d802c
Go to file
kor 359d3d802c Update preview image.
2018-11-05 01:51:30 +13:00
docs Clean up css and grid.js. 2018-11-05 01:08:31 +13:00
.gitattributes Fix readme and gitattributes. 2018-07-23 08:08:04 +12:00
.gitignore Add some dark souls entries. 2018-10-31 13:35:21 +13:00
.nojekyll Fix test github pages build fail. 2018-11-01 03:24:35 +13:00
icon.icns Refactor to utilize Electron. 2018-07-21 23:23:06 +12:00
icon.ico Refactor to utilize Electron. 2018-07-21 23:23:06 +12:00
icon.png Refactor to utilize Electron. 2018-07-21 23:23:06 +12:00
main.js Refactor. Clean up and fixing electron version write functionality breaking web version. 2018-08-09 04:32:54 +12:00
package.json Refactor to utilize Electron. 2018-07-21 23:23:06 +12:00
preload.js Add comments to preload.js. 2018-08-10 03:57:05 +12:00
PREVIEW.jpg Update preview image. 2018-11-05 01:51:30 +13:00
README.md Refactor griditem to article, menu to nav. 2018-11-04 00:50:24 +13:00

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

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