https://github.com/ryanfleck/journal
Personal journaling system. Hugo-based system for writing, organizing, and analysis of my personal journal entries.
https://github.com/ryanfleck/journal
Last synced: 5 months ago
JSON representation
Personal journaling system. Hugo-based system for writing, organizing, and analysis of my personal journal entries.
- Host: GitHub
- URL: https://github.com/ryanfleck/journal
- Owner: RyanFleck
- License: gpl-3.0
- Created: 2019-05-19T13:21:09.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-27T15:11:08.000Z (over 6 years ago)
- Last Synced: 2025-02-02T08:25:53.588Z (over 1 year ago)
- Language: HTML
- Homepage:
- Size: 68.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Journal
Hugo-based system for writing, organizing, and analysis of my personal journal entries. This repository includes the theme, all required scripts, and a few sample entries. Obviously I won't be placing my personal entries in this repository.
**Why?** My Github academic discount has expired, and I can no longer publish github pages sites for private repositories. Thus, personal information must be scrubbed from all private repositories, history must be deleted, and my journal needs to be moved to a serve-from-localhost system.
Metrics and analysis of posts will be integrated at a later date, utilizing *D3* for visuals.
**Development Progress:**
- [x] Write hugo site.
- [x] Port shell scripts.
## Installation
1. Download the zip and copy the contents into a new private repository.
2. Install **Hugo** and **vim**, though the system can be easily modified to use your editor of choice.
3. Add the `globalscripts` folder to your `PATH`. (GNU/Linux/Unix only.)
## Usage
- `je` can be called from anywhere to add a new daily file if one does not exist, add a new timestamp, and place the cursor in the correct location for the user to begin a new entry.
- `jv` can be called from anywhere to spin up the hugo site locally and open the configured browser to the homepage.
Calling `jv` builds and opens the site in firefox, and currently appears like the image below. The actual site is less than 100 lines of Hugo-HTML and CSS. Currently the GUI displays a table of contents that is linked to each post header, and every post in chronological order.
