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

Improve README formatting.

Browse Source
This commit is contained in:
kor 2018-10-31 15:05:47 +13:00
parent 9c1f5b4733
commit d82683859a
1 changed files with 27 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -45,29 +45,31 @@ Stored in a human-readable, flat-file database called [Indental](https://wiki.xx
[docs/content/settings.js](docs/content/settings.js)
- STATSNUMTAGS = max limit of tags to show in menu
- STATSNUMTYPE = max limit of types to show in menu
- WIDEGRIDITEM = allow wide entries (manually set by `WIDE : true` or automatic long `NOTES`)
- AUTOWIDETRIGGER = automaticly wide entry if it has more QOTE entries this number
- 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)
- GRIDITEMIDBASE = CSS name prefix
- SHOWUPPER = toggle display of upper entry elements
- SHOWTITLE = toggle display of entry title
- SHOWAUTH = toggle display of entry author
- SHOWTYPE = toggle display of entry type(s)
- SHOWLINK = toggle display of entry link(s)
- SHOWLOWER = toggle display of lower entry elements
- 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 on hover of image type entry
| Setting | Description |
| ---: | :--- |
| STATSNUMTAGS | max limit of tags to show in menu |
| STATSNUMTYPE | max limit of types to show in menu |
| WIDEGRIDITEM | allow wide entries (manually set by `WIDE : true` or more than 'AUTOWIDETRIGGER' number of `QOTES`) |
| AUTOWIDETRIGGER | automaticly wide entry if it has more QOTE entries this number |
| 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) |
| GRIDITEMIDBASE | 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 on hover of image type entry |
### Web Development
```
@ -90,11 +92,11 @@ npm start
### Dependencies
- App builder: [Electron](https://electronjs.org/)
- Database parser: [Indental](https://wiki.xxiivv.com/#indental)
- Template parser: [Runic](https://wiki.xxiivv.com/#runic)
- Grid layout: [Masonry](https://masonry.desandro.com/)
- Theming: [Themes](https://github.com/hundredrabbits/Themes)
- Grid layout: [Masonry](https://masonry.desandro.com/)
- App builder: [Electron](https://electronjs.org/)
### Thanks