memex/README.md

115 lines
5.5 KiB
Markdown
Raw Normal View History

2018-10-31 00:16:08 +00:00
[**Live web version here**](https://kormyen.github.io/memex/)
**Memex** is a [personal knowledge base](https://scholar.colorado.edu/csci_techreports/931/).
A bookmarks and notes application to help with storage and overview.
2018-07-13 15:56:09 +00:00
<img src='https://raw.githubusercontent.com/kormyen/memex/master/PREVIEW.jpg'/>
2018-07-21 11:23:06 +00:00
Memex has two modes:
2018-07-23 13:34:41 +00:00
1. **website** that is read-only and 'sever-less' for easy sharing
2. **standalone** application for bookmark and note cataloging
2018-07-21 11:23:06 +00:00
Memex supports:
2018-07-23 13:34:41 +00:00
- filtering
2018-10-30 09:20:34 +00:00
- tags
2018-07-21 11:23:06 +00:00
- images
- notes
- quotes
- terms
2018-10-30 09:20:34 +00:00
- links
- author
- files
- projects
2018-10-31 02:10:25 +00:00
- themes
2018-10-30 09:20:34 +00:00
2018-11-01 11:19:45 +00:00
To change theme simply drag a [theme svg file](https://github.com/hundredrabbits/Themes/tree/master/themes) onto the Memex webpage or app
2018-10-30 09:33:02 +00:00
2018-11-01 11:19:45 +00:00
More information on themes can be found [here](https://github.com/hundredrabbits/Themes)
2018-07-17 21:04:33 +00:00
2018-10-31 00:16:08 +00:00
### Live Examples
2018-10-31 02:10:25 +00:00
- [Kormyen's Memex](https://kormyen.github.io/memex/) - this repo
- [Shinestrength's Portfolio](http://www.shinestrength.xyz/) - [repo](https://github.com/shinestrength/memex)
- Dotcli's Memex - [repo](https://github.com/dotcli/memex)
2018-10-31 00:16:08 +00:00
2018-10-31 02:19:19 +00:00
### Web Development
```
git clone git@github.com:kormyen/memex.git
```
2018-11-01 11:19:45 +00:00
Then open `memex/docs/index.html` in any web browser
2018-10-31 02:19:19 +00:00
2018-11-01 11:19:45 +00:00
The web content is isolated in a folder to seperate it from Electron (app-building) files
2018-10-31 02:19:19 +00:00
2018-11-01 11:19:45 +00:00
The folder is called 'docs' so that the 'Github Pages' feature can host it, another folder name doesn't seem supported
2018-10-31 02:19:19 +00:00
### App Development
```
git clone git@github.com:kormyen/memex.git
cd memex
npm install
npm start
```
2018-10-31 00:12:31 +00:00
### Data
2018-10-31 02:19:19 +00:00
[memex/docs/content/data.ndtl](docs/content/data.ndtl)
2018-07-21 11:23:06 +00:00
2018-10-31 00:16:08 +00:00
Stored in a human-readable, flat-file database called [Indental](https://wiki.xxiivv.com/#indental) which is made by Devine Lu Linvega
2018-07-13 15:56:09 +00:00
2018-10-31 00:12:31 +00:00
### Settings
2018-10-31 02:19:19 +00:00
[memex/docs/content/settings.js](docs/content/settings.js)
2018-10-31 00:12:31 +00:00
2018-10-31 02:05:47 +00:00
| 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 |
2018-10-31 02:05:47 +00:00
| USEMASONRY | enable [masonry](https://masonry.desandro.com/) layout library usage |
| MASONRYPROGRESS | masonry re-layout as images load (true), or only once all images complete (false) |
| ARTICLEIDBASE | CSS name prefix |
2018-10-31 02:05:47 +00:00
| 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) |
2018-10-31 02:19:19 +00:00
| SHOWOVERLAY | toggle display of dark overlay shown when hovering image type entries to improve text readability |
2018-07-23 12:37:55 +00:00
2018-10-31 00:12:31 +00:00
### Dependencies
2018-07-13 15:56:09 +00:00
- Database parser: [Indental](https://wiki.xxiivv.com/#indental)
2018-10-30 09:20:34 +00:00
- Theming: [Themes](https://github.com/hundredrabbits/Themes)
2018-10-31 02:05:47 +00:00
- Grid layout: [Masonry](https://masonry.desandro.com/)
- App builder: [Electron](https://electronjs.org/)
2018-11-01 04:46:02 +00:00
- Icons: [Font Awesome](https://fontawesome.com/)
2018-10-30 09:20:34 +00:00
2018-10-31 00:12:31 +00:00
### Thanks
2018-07-22 20:31:38 +00:00
2018-10-31 00:12:31 +00:00
- Devine Lu Linvega ([Oscean](https://github.com/XXIIVV/Oscean))
- Rekka Bell ([kokorobot](https://github.com/rekkabell/kokorobot))
- Hundred Rabbits ([Ecosystem](https://github.com/hundredrabbits))
- Josh Avanier ([Log](https://github.com/joshavanier/log))
- Alexey Botkov ([Legacy](https://github.com/nomand/Legacy))
- Seena Burns ([Isolate](https://github.com/seenaburns/isolate))
2018-07-23 12:37:55 +00:00
---
Hamish MacDonald
**[Twitter](https://twitter.com/kormyen)** &middot; **[Home](https://kor.nz)**