diff --git a/.gitattributes b/.gitattributes index 298479a..830fbe2 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1 @@ -docs/logic/lib/* linguist-vendored \ No newline at end of file +logic/lib/* linguist-vendored \ No newline at end of file diff --git a/.gitignore b/.gitignore index ff5b17e..fc9fef1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,11 +1,8 @@ -node_modules/ -builds/ .DS_Store */.DS_Store -package-lock.json -docs/content/media/*.pdf -docs/content/media/*.zip -docs/content/media/*.rar -docs/content/media/*.html -docs/content/media/*.mobi \ No newline at end of file +content/media/*.pdf +content/media/*.zip +content/media/*.rar +content/media/*.html +content/media/*.mobi \ No newline at end of file diff --git a/README.md b/README.md index a9cd212..f8b4879 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,12 @@ **Memex** is a [personal knowledge base](https://scholar.colorado.edu/csci_techreports/931/). -A bookmarks and notes application to help with storage and overview. +A bookmarks and notes tool to help with storage and overview. + +Read-only and 'sever-less' for easy sharing. -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 @@ -25,7 +22,7 @@ Memex supports: - projects - themes -To change theme simply drag a [theme svg file](https://github.com/hundredrabbits/Themes/tree/master/themes) onto the Memex webpage or app +To change theme simply drag a [theme svg file](https://github.com/hundredrabbits/Themes/tree/master/themes) onto the Memex webpage More information on themes can be found [here](https://github.com/hundredrabbits/Themes) @@ -40,29 +37,17 @@ More information on themes can be found [here](https://github.com/hundredrabbits 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 -``` +Then open `memex/index.html` in any web browser ### Data -[memex/docs/content/data.ndtl](docs/content/data.ndtl) +[memex/content/data.ndtl](content/data.ndtl) Stored in a human-readable, flat-file database called [Indental](https://wiki.xxiivv.com/#indental) which is made by Devine Lu Linvega ### Settings -[memex/docs/content/settings.js](docs/content/settings.js) +[memex/content/settings.js](content/settings.js) | Setting | Description | | ---: | :--- | @@ -96,7 +81,6 @@ Stored in a human-readable, flat-file database called [Indental](https://wiki.xx - Database parser: [Indental](https://wiki.xxiivv.com/#indental) - Theming: [Themes](https://github.com/hundredrabbits/Themes) - Grid layout: [Masonry](https://masonry.desandro.com/) -- App builder: [Electron](https://electronjs.org/) - Icons: [Font Awesome](https://fontawesome.com/) ### Thanks diff --git a/docs/asset/fontawesome/LICENSE.txt b/asset/fontawesome/LICENSE.txt similarity index 100% rename from docs/asset/fontawesome/LICENSE.txt rename to asset/fontawesome/LICENSE.txt diff --git a/docs/asset/fontawesome/css/all.css b/asset/fontawesome/css/all.css similarity index 100% rename from docs/asset/fontawesome/css/all.css rename to asset/fontawesome/css/all.css diff --git a/docs/asset/fontawesome/css/brands.css b/asset/fontawesome/css/brands.css similarity index 100% rename from docs/asset/fontawesome/css/brands.css rename to asset/fontawesome/css/brands.css diff --git a/docs/asset/fontawesome/css/fontawesome.css b/asset/fontawesome/css/fontawesome.css similarity index 100% rename from docs/asset/fontawesome/css/fontawesome.css rename to asset/fontawesome/css/fontawesome.css diff --git a/docs/asset/fontawesome/css/regular.css b/asset/fontawesome/css/regular.css similarity index 100% rename from docs/asset/fontawesome/css/regular.css rename to asset/fontawesome/css/regular.css diff --git a/docs/asset/fontawesome/css/solid.css b/asset/fontawesome/css/solid.css similarity index 100% rename from docs/asset/fontawesome/css/solid.css rename to asset/fontawesome/css/solid.css diff --git a/docs/asset/fontawesome/css/svg-with-js.css b/asset/fontawesome/css/svg-with-js.css similarity index 100% rename from docs/asset/fontawesome/css/svg-with-js.css rename to asset/fontawesome/css/svg-with-js.css diff --git a/docs/asset/fontawesome/css/v4-shims.css b/asset/fontawesome/css/v4-shims.css similarity index 100% rename from docs/asset/fontawesome/css/v4-shims.css rename to asset/fontawesome/css/v4-shims.css diff --git a/docs/asset/fontawesome/css/v4-shims.min.css b/asset/fontawesome/css/v4-shims.min.css similarity index 100% rename from docs/asset/fontawesome/css/v4-shims.min.css rename to asset/fontawesome/css/v4-shims.min.css diff --git a/docs/asset/fontawesome/webfonts/fa-regular-400.ttf b/asset/fontawesome/webfonts/fa-regular-400.ttf similarity index 100% rename from docs/asset/fontawesome/webfonts/fa-regular-400.ttf rename to asset/fontawesome/webfonts/fa-regular-400.ttf diff --git a/docs/asset/fontawesome/webfonts/fa-solid-900.ttf b/asset/fontawesome/webfonts/fa-solid-900.ttf similarity index 100% rename from docs/asset/fontawesome/webfonts/fa-solid-900.ttf rename to asset/fontawesome/webfonts/fa-solid-900.ttf diff --git a/docs/asset/style.css b/asset/style.css similarity index 100% rename from docs/asset/style.css rename to asset/style.css diff --git a/docs/content/data.ndtl b/content/data.ndtl similarity index 100% rename from docs/content/data.ndtl rename to content/data.ndtl diff --git a/docs/content/media/12017-01-20_van.jpg b/content/media/12017-01-20_van.jpg similarity index 100% rename from docs/content/media/12017-01-20_van.jpg rename to content/media/12017-01-20_van.jpg diff --git a/docs/content/media/12018-03-20_fpvMod.jpg b/content/media/12018-03-20_fpvMod.jpg similarity index 100% rename from docs/content/media/12018-03-20_fpvMod.jpg rename to content/media/12018-03-20_fpvMod.jpg diff --git a/docs/content/media/12018-05-03_slide.jpg b/content/media/12018-05-03_slide.jpg similarity index 100% rename from docs/content/media/12018-05-03_slide.jpg rename to content/media/12018-05-03_slide.jpg diff --git a/docs/content/media/12018-05-18_ardusamberTimeAndDate.jpg b/content/media/12018-05-18_ardusamberTimeAndDate.jpg similarity index 100% rename from docs/content/media/12018-05-18_ardusamberTimeAndDate.jpg rename to content/media/12018-05-18_ardusamberTimeAndDate.jpg diff --git a/docs/content/media/12018-06-04_ardusamber.jpg b/content/media/12018-06-04_ardusamber.jpg similarity index 100% rename from docs/content/media/12018-06-04_ardusamber.jpg rename to content/media/12018-06-04_ardusamber.jpg diff --git a/docs/content/media/12018-06-10_livingBridge.jpg b/content/media/12018-06-10_livingBridge.jpg similarity index 100% rename from docs/content/media/12018-06-10_livingBridge.jpg rename to content/media/12018-06-10_livingBridge.jpg diff --git a/docs/content/media/12018-07-04_dastime.jpg b/content/media/12018-07-04_dastime.jpg similarity index 100% rename from docs/content/media/12018-07-04_dastime.jpg rename to content/media/12018-07-04_dastime.jpg diff --git a/docs/content/media/12018-07-05_vns.jpg b/content/media/12018-07-05_vns.jpg similarity index 100% rename from docs/content/media/12018-07-05_vns.jpg rename to content/media/12018-07-05_vns.jpg diff --git a/docs/content/media/12018-07-07_eelfroth.jpg b/content/media/12018-07-07_eelfroth.jpg similarity index 100% rename from docs/content/media/12018-07-07_eelfroth.jpg rename to content/media/12018-07-07_eelfroth.jpg diff --git a/docs/content/media/12018-07-10_switchPanel.jpg b/content/media/12018-07-10_switchPanel.jpg similarity index 100% rename from docs/content/media/12018-07-10_switchPanel.jpg rename to content/media/12018-07-10_switchPanel.jpg diff --git a/docs/content/media/12018-07-13_WDR_Kennedy - Administration of Research in a Research Corporation table.png b/content/media/12018-07-13_WDR_Kennedy - Administration of Research in a Research Corporation table.png similarity index 100% rename from docs/content/media/12018-07-13_WDR_Kennedy - Administration of Research in a Research Corporation table.png rename to content/media/12018-07-13_WDR_Kennedy - Administration of Research in a Research Corporation table.png diff --git a/docs/content/media/12018-07-18_theNatanievOverseer.jpg b/content/media/12018-07-18_theNatanievOverseer.jpg similarity index 100% rename from docs/content/media/12018-07-18_theNatanievOverseer.jpg rename to content/media/12018-07-18_theNatanievOverseer.jpg diff --git a/docs/content/media/12018-07-19_black.jpg b/content/media/12018-07-19_black.jpg similarity index 100% rename from docs/content/media/12018-07-19_black.jpg rename to content/media/12018-07-19_black.jpg diff --git a/docs/content/media/12018-07-19_tall.jpg b/content/media/12018-07-19_tall.jpg similarity index 100% rename from docs/content/media/12018-07-19_tall.jpg rename to content/media/12018-07-19_tall.jpg diff --git a/docs/content/media/12018-07-19_white.jpg b/content/media/12018-07-19_white.jpg similarity index 100% rename from docs/content/media/12018-07-19_white.jpg rename to content/media/12018-07-19_white.jpg diff --git a/docs/content/media/12018-07-19_wide.jpg b/content/media/12018-07-19_wide.jpg similarity index 100% rename from docs/content/media/12018-07-19_wide.jpg rename to content/media/12018-07-19_wide.jpg diff --git a/docs/content/media/12018-07-27_starTiger.jpg b/content/media/12018-07-27_starTiger.jpg similarity index 100% rename from docs/content/media/12018-07-27_starTiger.jpg rename to content/media/12018-07-27_starTiger.jpg diff --git a/docs/content/media/12018-08-11_med.gif b/content/media/12018-08-11_med.gif similarity index 100% rename from docs/content/media/12018-08-11_med.gif rename to content/media/12018-08-11_med.gif diff --git a/docs/content/media/12018-09-06_ikigai.jpg b/content/media/12018-09-06_ikigai.jpg similarity index 100% rename from docs/content/media/12018-09-06_ikigai.jpg rename to content/media/12018-09-06_ikigai.jpg diff --git a/docs/content/media/12018-09-16_katakomby.jpg b/content/media/12018-09-16_katakomby.jpg similarity index 100% rename from docs/content/media/12018-09-16_katakomby.jpg rename to content/media/12018-09-16_katakomby.jpg diff --git a/docs/content/media/12018-09-26_moonPrecession.jpg b/content/media/12018-09-26_moonPrecession.jpg similarity index 100% rename from docs/content/media/12018-09-26_moonPrecession.jpg rename to content/media/12018-09-26_moonPrecession.jpg diff --git a/docs/content/media/12018-09-27_goldenAlpineLake.jpg b/content/media/12018-09-27_goldenAlpineLake.jpg similarity index 100% rename from docs/content/media/12018-09-27_goldenAlpineLake.jpg rename to content/media/12018-09-27_goldenAlpineLake.jpg diff --git a/docs/content/media/12018-09-29_atlantis.jpg b/content/media/12018-09-29_atlantis.jpg similarity index 100% rename from docs/content/media/12018-09-29_atlantis.jpg rename to content/media/12018-09-29_atlantis.jpg diff --git a/docs/content/media/12018-09-30_underseaCanyons.jpg b/content/media/12018-09-30_underseaCanyons.jpg similarity index 100% rename from docs/content/media/12018-09-30_underseaCanyons.jpg rename to content/media/12018-09-30_underseaCanyons.jpg diff --git a/docs/content/media/12018-10-02_magneticTurbulence.jpg b/content/media/12018-10-02_magneticTurbulence.jpg similarity index 100% rename from docs/content/media/12018-10-02_magneticTurbulence.jpg rename to content/media/12018-10-02_magneticTurbulence.jpg diff --git a/docs/content/media/12018-10-03_alaskaFall.jpg b/content/media/12018-10-03_alaskaFall.jpg similarity index 100% rename from docs/content/media/12018-10-03_alaskaFall.jpg rename to content/media/12018-10-03_alaskaFall.jpg diff --git a/docs/content/media/12018-10-04_scotlandMountain.jpg b/content/media/12018-10-04_scotlandMountain.jpg similarity index 100% rename from docs/content/media/12018-10-04_scotlandMountain.jpg rename to content/media/12018-10-04_scotlandMountain.jpg diff --git a/docs/content/media/12018-10-15_goodbyeMoon.jpg b/content/media/12018-10-15_goodbyeMoon.jpg similarity index 100% rename from docs/content/media/12018-10-15_goodbyeMoon.jpg rename to content/media/12018-10-15_goodbyeMoon.jpg diff --git a/docs/content/media/12018-10-17_20years20questions.jpg b/content/media/12018-10-17_20years20questions.jpg similarity index 100% rename from docs/content/media/12018-10-17_20years20questions.jpg rename to content/media/12018-10-17_20years20questions.jpg diff --git a/docs/content/media/12018-10-17_curiosity.jpg b/content/media/12018-10-17_curiosity.jpg similarity index 100% rename from docs/content/media/12018-10-17_curiosity.jpg rename to content/media/12018-10-17_curiosity.jpg diff --git a/docs/content/media/12018-10-18_internetJade.jpg b/content/media/12018-10-18_internetJade.jpg similarity index 100% rename from docs/content/media/12018-10-18_internetJade.jpg rename to content/media/12018-10-18_internetJade.jpg diff --git a/docs/content/media/12018-10-19_billainHorizon.jpg b/content/media/12018-10-19_billainHorizon.jpg similarity index 100% rename from docs/content/media/12018-10-19_billainHorizon.jpg rename to content/media/12018-10-19_billainHorizon.jpg diff --git a/docs/content/media/12018-10-25_bo Bartlett.jpg b/content/media/12018-10-25_bo Bartlett.jpg similarity index 100% rename from docs/content/media/12018-10-25_bo Bartlett.jpg rename to content/media/12018-10-25_bo Bartlett.jpg diff --git a/docs/content/media/12018-10-30_grain2013.jpg b/content/media/12018-10-30_grain2013.jpg similarity index 100% rename from docs/content/media/12018-10-30_grain2013.jpg rename to content/media/12018-10-30_grain2013.jpg diff --git a/docs/content/media/12018-10-31_threshingNest.jpg b/content/media/12018-10-31_threshingNest.jpg similarity index 100% rename from docs/content/media/12018-10-31_threshingNest.jpg rename to content/media/12018-10-31_threshingNest.jpg diff --git a/docs/content/media/12018-11-06_komiyaMa.png b/content/media/12018-11-06_komiyaMa.png similarity index 100% rename from docs/content/media/12018-11-06_komiyaMa.png rename to content/media/12018-11-06_komiyaMa.png diff --git a/docs/content/media/12018-11-06_travel.jpg b/content/media/12018-11-06_travel.jpg similarity index 100% rename from docs/content/media/12018-11-06_travel.jpg rename to content/media/12018-11-06_travel.jpg diff --git a/docs/content/media/12019-01-04_birds.jpg b/content/media/12019-01-04_birds.jpg similarity index 100% rename from docs/content/media/12019-01-04_birds.jpg rename to content/media/12019-01-04_birds.jpg diff --git a/docs/content/media/12019-02-01_oil.jpg b/content/media/12019-02-01_oil.jpg similarity index 100% rename from docs/content/media/12019-02-01_oil.jpg rename to content/media/12019-02-01_oil.jpg diff --git a/docs/content/media/12019-02-02_sailDirections.jpg b/content/media/12019-02-02_sailDirections.jpg similarity index 100% rename from docs/content/media/12019-02-02_sailDirections.jpg rename to content/media/12019-02-02_sailDirections.jpg diff --git a/docs/content/media/12019-02-02_tiltedLoss.jpg b/content/media/12019-02-02_tiltedLoss.jpg similarity index 100% rename from docs/content/media/12019-02-02_tiltedLoss.jpg rename to content/media/12019-02-02_tiltedLoss.jpg diff --git a/docs/content/settings.js b/content/settings.js similarity index 100% rename from docs/content/settings.js rename to content/settings.js diff --git a/icon.icns b/icon.icns deleted file mode 100644 index 5c52ced..0000000 Binary files a/icon.icns and /dev/null differ diff --git a/icon.ico b/icon.ico deleted file mode 100644 index b380d3b..0000000 Binary files a/icon.ico and /dev/null differ diff --git a/icon.png b/icon.png deleted file mode 100644 index ddbe84c..0000000 Binary files a/icon.png and /dev/null differ diff --git a/docs/index.html b/index.html similarity index 100% rename from docs/index.html rename to index.html diff --git a/docs/logic/add.js b/logic/add.js similarity index 100% rename from docs/logic/add.js rename to logic/add.js diff --git a/docs/logic/lib/imagesloaded.js b/logic/lib/imagesloaded.js similarity index 100% rename from docs/logic/lib/imagesloaded.js rename to logic/lib/imagesloaded.js diff --git a/docs/logic/lib/indental.js b/logic/lib/indental.js similarity index 100% rename from docs/logic/lib/indental.js rename to logic/lib/indental.js diff --git a/docs/logic/lib/masonry.js b/logic/lib/masonry.js similarity index 100% rename from docs/logic/lib/masonry.js rename to logic/lib/masonry.js diff --git a/docs/logic/lib/theme.js b/logic/lib/theme.js similarity index 100% rename from docs/logic/lib/theme.js rename to logic/lib/theme.js diff --git a/docs/logic/lightbox.js b/logic/lightbox.js similarity index 100% rename from docs/logic/lightbox.js rename to logic/lightbox.js diff --git a/docs/logic/main.js b/logic/main.js similarity index 100% rename from docs/logic/main.js rename to logic/main.js diff --git a/docs/logic/seer.js b/logic/seer.js similarity index 100% rename from docs/logic/seer.js rename to logic/seer.js diff --git a/docs/logic/view/grid.js b/logic/view/grid.js similarity index 100% rename from docs/logic/view/grid.js rename to logic/view/grid.js diff --git a/docs/logic/view/nav.js b/logic/view/nav.js similarity index 100% rename from docs/logic/view/nav.js rename to logic/view/nav.js diff --git a/docs/logic/view/util.js b/logic/view/util.js similarity index 100% rename from docs/logic/view/util.js rename to logic/view/util.js diff --git a/docs/logic/wrap.js b/logic/wrap.js similarity index 100% rename from docs/logic/wrap.js rename to logic/wrap.js diff --git a/main.js b/main.js deleted file mode 100644 index 8e47962..0000000 --- a/main.js +++ /dev/null @@ -1,120 +0,0 @@ -const {app, BrowserWindow, webFrame, Menu} = require('electron') -const path = require('path') -const url = require('url') -const shell = require('electron').shell; -const fs = require('fs'); -const { ipcMain } = require('electron'); -const FILELOCATION = 'docs/content/data.ndtl'; - -let is_shown = true; - -this.handleRedirect = (e, url) => -{ - if(url != app.win.webContents.getURL()) - { - e.preventDefault() - require('electron').shell.openExternal(url) - } -} - -app.inspect = function() -{ - app.win.toggleDevTools(); -} - -app.toggle_fullscreen = function() -{ - app.win.setFullScreen(app.win.isFullScreen() ? false : true); -} - -app.toggle_visible = function() -{ - if(process.platform == "win32") - { - if(!app.win.isMinimized()) - { - app.win.minimize(); - } - else - { - app.win.restore(); - } - } - else - { - if(is_shown) - { - app.win.hide(); - } - else - { - app.win.show(); - } - } -} - -app.inject_menu = function(m) -{ - Menu.setApplicationMenu(Menu.buildFromTemplate(m)); -} - -app.path = function() -{ - return __dirname -} - -app.win = null; - -app.on('ready', () => -{ - app.win = new BrowserWindow( - { - webPreferences: - { - nodeIntegration: true, - preload: path.join(__dirname, 'preload.js') - }, width: 950, height: 950, backgroundColor:"#ddd", minWidth: 587, minHeight: 540, frame:true, autoHideMenuBar: true, icon: __dirname + '/icon.ico' - }) - - app.win.loadURL(`file://${__dirname}/docs/index.html`); - - app.win.on('closed', () => - { - win = null - app.quit() - }) - - app.win.on('hide', function() - { - is_shown = false; - }) - - app.win.on('show', function() - { - is_shown = true; - }) - - app.win.webContents.on('will-navigate', this.handleRedirect) - app.win.webContents.on('new-window', this.handleRedirect) -}) - -app.on('window-all-closed', () => -{ - app.quit() -}) - -app.on('activate', () => -{ - if (app.win === null) { - createWindow() - } -}) - -ipcMain.on('write', (event, arg) => -{ - fs.appendFile(FILELOCATION, arg, function (err) - { - if (err) throw err; - console.log('Saved!'); - }); -}); \ No newline at end of file diff --git a/package.json b/package.json deleted file mode 100644 index 53e7d30..0000000 --- a/package.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "name": "Memex", - "productName": "Memex", - "version": "0.1.0", - "main": "main.js", - "scripts": { - "start": "electron .", - "clean": "rm -r builds/Memex-darwin-x64/ ; rm -r builds/Memex-linux-x64/ ; rm -r builds/Memex-win32-x64/ ; rm -r builds/Memex-linux-armv7l ; echo 'cleaned build location'", - "build_osx": "electron-packager . Memex --platform=darwin --arch=x64 --out builds/ --overwrite --icon=icon.icns && echo 'Built for OSX'", - "build_linux": "electron-packager . Memex --platform=linux --arch=x64 --out builds/ --overwrite --icon=icon.ico && echo 'Built for LINUX'", - "build_win": "electron-packager . Memex --platform=win32 --arch=x64 --out builds/ --overwrite --icon=icon.ico && echo 'Built for WIN'", - "build_pi": "electron-packager . Memex --platform=linux --arch=armv7l --out builds/ --overwrite --icon=icon.ico ; echo 'Built for PI'" - }, - "devDependencies": { - "electron": "^1.8.1" - }, - "dependencies": { - "electron-packager": "^12.0.1" - } -} diff --git a/preload.js b/preload.js deleted file mode 100644 index 0a36008..0000000 --- a/preload.js +++ /dev/null @@ -1,10 +0,0 @@ -// This formats 'require' for use in logic/add.js used for send-ing a method call to the electron app/ -window.nodeRequire = require; -delete window.require; -delete window.exports; -delete window.module; - -// This preload.js file is included by electron, but not loaded in the web version. -// Defining 'window.showAdd' to true tells the app to include the add entry -// menu button and functionality which is not currently supported in the web version. -window.showAdd = true; \ No newline at end of file