brennanbrown / enjoyment-work Goto Github PK

🗃️ A Digital Garden: Capturing my daily thoughts and progress, as well as curated ideas with unique synthesis—a personal zettelkasten. Built on Simply Jekyll by Raghuveer S.

Home Page: https://enjoyment-work.netlify.app

License: MIT License

HTML 49.22% Ruby 1.53% CSS 34.03% JavaScript 15.22%

digital-garden jekyll obsidian

enjoyment-work's Introduction

Enjoyment Work: Theme for Jekyll

An extensive Jekyll theme designed to have similar functionality to Roam Research.
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Enjoyment Work is an academic / research-focused theme that provides extensive features for note-taking and personal growth. It is based off of the Digital Garden philosophy, which you can read more about on the demo site

The next step for Enjoyment Work is to properly configure the syntax required to work with Obsidian, a powerful knowledge base that works on top of a local folder of plain text Markdown files. Which would ultimately allow somebody to turn their Obsidian notes into an online blog by simply using the _notes directory.

There are several other planned features in the Roadmap ahead, as the project is far from perfect. It is currently using the Bootstrap 4 framework, which although is powerful and extensive, does slow thing down, along with the rather large style.css file which needs to be trimmed down and converted into SASS.

If you like the idea of being able to use Jekyll as a free alternative to Roam Research, Notion, etc. then please feel free to use this template, or even better, contribute to this project by submitting a pull request or creating an issue! First-time contributors are definitely welcomed!

In addition, I have created three other free Jekyll themes that you might be interested in:

🚰 Watery: A minimalist, bare-bones theme for Jekyll only using the Water.css framework while still following the best practices for accessibility and search-engine optimization.
📔 Purelog: A responsive sidebar Jekyll theme using the Pure.css framework, designed for writers and bloggers of all kinds.
Classic Spirits: A classic sidebar Jekyll theme for old-school blogging, created with the Bulma framework. Built on Soot Spirits by Abhishek Nagekar.

Features

Here are a few interesting features of this Jekyll theme:

A fully customizable and empty _BLANK_config.yml to make getting up-and-running easy.
A speedy, on-site search function using Simply Jekyll Search.
Custom collections for different types of material (note-taking, journal writing, etc.)
An auto-generating /archive page that displays all entries from all collections.
Auto-generating /tags and /categories pages.
Breadcrumbs for improved navigation and SEO.
Having a _pages collection for easier organization.
An author bio at the end of each post. (Located in _inclues/author.html)
Full Rouge support for syntax highlighting. (Currently using base16.dark)
Auto-generated RSS feed, sitemap, accessibility features, and search-engine optimization.
Creates backlinks to other notes automatically
Context menu on feed to instantly see related posts and backlinks
Supports Roam-style double bracket link syntax to other notes
On hover page previews
Features a simple and responsive design
Supports Markdown or HTML notes

Installation

Prerequisites

Jekyll requires the following:

Ruby version 2.5.0 or higher
RubyGems
GCC and Make

See Requirements for guides and details.

Instructions

Install all prerequisites.
Install the jekyll and bundler gems.

gem install jekyll bundler

Clone this repository.

git clone https://github.com/brennanbrown/enjoyment-work.git

Change into your new directory.

cd enjoyment-work

Install gems from the Gemfile.

bundle install

Build the site and make it available on a local server.

bundle exec jekyll serve

Browse to http://localhost:4000

If you encounter any errors during this process, check that you have installed all the prerequisites in Requirements.

If you still have issues, see Troubleshooting.

Getting Started

Once you have Jekyll up-and-running, there are only a few steps needed to make this theme your own:

Fill out the _BLANK_config.yml configuration file and replace the current _config.yml
Remove the example_posts folder in _posts, _notes, _journals and start writing your own!
Modify or remove the pages in _pages to however you see fit.
(Optional) Modify or remove this README.md with information about your own project or blog.
(Optional) Modify the CSS files in the assets folder to customize the site.

Roadmap

There are several features that I'm still planning to create and integrate, including:

Optimize and minify the stylesheets and design.
Configure to work with Obsidian out-of-the-box.
Create a Theme Gem
Add easy and automatic buttons to "Deploy to Netlify", Heroku, etc.
Add Travis continious integration checks
Add additional documentation for creating custom collections and auto generated pages
Add more example posts and articles

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the MIT License. You can use this project however you see fit without needing to give attribution.

See LICENSE for more information.

Resources

While creating this theme, I came across a lot of helpful and hard-to-find resources. If you'd like to dive deeper into Jekyll, check them out:

Jumping Into Jekyll: https://dev.to/brennan/jumping-into-jekyll-4o9h
Jekyll Cheatsheet: https://devhints.io/jekyll
Course on Jekyll: https://learn-the-web.algonquindesign.ca/topics/jekyll/
Jekyll for Designers: http://simpleprimate.com/jekyll-for-designers/index.html
Dynamic Copyright on Jekyll: https://michaelsoolee.com/jekyll-copyright/
Creating breadcrumbs in Jekyll: https://jekyllcodex.org/without-plugin/breadcrumbs/
Display all items from ALL collections: https://stackoverflow.com/questions/31171041/listing-all-collections-in-jekyll

Other Resources

For markdown previews: https://jaspervdj.be/lorem-markdownum/
Case Study on webfont performance: https://www.keycdn.com/blog/web-font-performance
An extensive .gitignore: https://miguelmota.com/bytes/extensive-gitignore/

Credit

Simply Jekyll was created by Raghuveer S.

Simple Jekyll Search was created by Christian Fei.

enjoyment-work's People

Contributors

Stargazers

Watchers

Forkers

sugardayfox it-zone stbetc geauxweisbeck4 alxmzr mustafaerbay myh333777 stardoom2 deltaceph stardoom4

enjoyment-work's Issues

Wrong mathjax rendering

In my site, I have following markdown:

---
title: Vim Commands
tags: programming
toc: true
comments: true
---

- Vim
    - command
        - 輸入go這個字串30次: ` 30igo "esc" `
        - finding
            - ` fX `: 找下一個字元X，游標放在X上
            - `FX `: 找上一個字元X，游標放在X上
            - ` ; `: 同一個方向，重複上一步
            - `, `: 反方向，重複上一步
        - moving
            - ` b `: 往前移到字首
            - ` w `: 往後移到字首
            - ` e `: 移到字尾
            - ` ctrl+o `: 移到上一個拜訪過的位置
            - ` ctrl+i `: 移到下一個拜訪過的位置
            - ` ^ `: 移到行首非空字元
            - ` $ `: 移到行末
        - editing
            - ` A `: move to the end of the line and editing
            - ` I `: move to the start of the line and editing
            - ` ea `: edit at the end of the word
            - ` di} `: 刪除{}裡的所有東西
        - mark
            - ` ma `: 把現在滑鼠的位置標記成a
            - ` `a `: 移到a這個mark的位置(exact position)
            - ` 'a `: 移到a這個mark第一個非空字元
        - delete or change
            - ` D `: 刪除該行cursor後
            - ` x `: 刪除cursor在的位置
            - ` X `: 刪除cursor前的字元
            - ` rb `: 把游標選起來的地方replace成b，b可換成其他的字元
            - ` s `: 把游標選起來的地方刪除，並進入插入模式
            - ` ciw `: 把游標在的整個字詞刪除，並進入插入模式
            - ` cw `: 把整個字詞從游標在的位置以後刪除，並進入插入模式
        - yank
            - ` yi( `: 當游標在()裡，複製()裡的東西
    - open files
        - 用tab開啟資料夾中的所有檔案: ` vim -p * `
        - 關閉tab中所有檔案: ` :qa `  or ` :wqa `
    - ` .vimrc `
        - highlight 搜尋的結果
            - [Highlight all search pattern matches](https://vim.fandom.com/wiki/Highlight_all_search_pattern_matches)
    - register
        - [!Resource](!Resource.md)
            - [Vim registers: The basics and beyond](https://www.brianstorti.com/vim-registers/)
            - [vi - How do I use vim registers? - Stack Overflow](https://stackoverflow.com/questions/1497958/how-do-i-use-vim-registers)
        - how to copy to a named register k: ` "kyy `
        - how to paste from a named register k: ` "kp `
        - after I yank a texts and delete other texts, how to bring back the original one?: vim will save the last yanked item in register ` "0 ` , so press ` "0p `  on the keyboard.

But I got some strange math rendering like below:

Do you have any clues about solving this problem?
Btw, thanks for the great effort for making this theme and I really love it! <3

TOC error

Hello. Thank you for sharing your great blog template!

I'm trying to learn how to write posts. So I made one and then upload it.
However, the display was totally different from my localhost.
The thing is that the toc(table of contents) display the whole content instead of its titles or subtitles.

So, here is my post address.
and here is markdown file address from my github.

I even did the "toc : false", but it does not work. Can I know how can I solve this problem?

A Dark Monochromatic Theme

I created a site with your theme and It is the best theme for Jekyll , but it really misses a dark theme. So , a Dark Monochromatic Theme is really needed like in Gwern.net . A theme switch button would be great.

For borrowing ideas

Firstly, very nice theme and well put together. First time I’ve seen one that has a dedicated section for daily journal entries. I think that’s a great differentiator and something 99% of blog themes ignore. I’ve been playing around with journal.txt and if that can be integrated into a blog. I have it working and it’s nice just typing into a single txt, committing it and having Github actions build the posts and github pages host it. However, journaltxt doesn’t have many configuration options.

I noticed you talk about integration with Obsidian and I’d also found this theme. Likely you may have too but there could be some good stuff in for helping enjoyment-work along.

Build issue - due to ... potential "[..]Javascript will need refactoring[..]" ?

I'm not deploying in Netlify but in CloudCannon, ... and i'm having a build issue there, i reported them :

Hi CloudCannon,

While importing a (Jekyll) repo i get

...


Generating...

Jekyll Feed: Generating feed for posts

------------------------------------------------
Jekyll 4.0.0 Please append `--trace` to the `build` command for any additional information or backtrace.

------------------------------------------------

x Your build failed, make an update and try again.

Their answer mentions a potential JS cause of... i'm just reproducing it here below:

...
I have taken a look in to your site and the error seems to be coming from an asynchronous function in

assets/js/contextmenu.js

I commented out the async function getRelatedHTML and

function showRelated and the site built. I believe this Javascript will need refactoring and looked in to.

FYI,

ThX !

Netlify Deployment

Since updating Nokogiri, the default deployment to Netlify for the demo site hasn't been working.

2:10:03 PM: ────────────────────────────────────────────────────────────────
2:10:03 PM:   "build.command" failed                                        
2:10:03 PM: ────────────────────────────────────────────────────────────────
2:10:03 PM: 
2:10:03 PM:   Error message
2:10:03 PM:   Command failed with exit code 1: jekyll build
2:10:03 PM: 
2:10:03 PM:   Error location
2:10:03 PM:   In Build command from Netlify app:
2:10:03 PM:   jekyll build
2:10:03 PM: 
2:10:03 PM:   Resolved config
2:10:03 PM:   build:
2:10:03 PM:     command: jekyll build
2:10:03 PM:     commandOrigin: ui
2:10:03 PM:     publish: /opt/build/repo/_site
2:10:03 PM:   headers:
2:10:03 PM:     - for: /*
      values:
        Access-Control-Allow-Origin: '*'
  redirects:
    - from: /*
      status: 200
      to: /index.html

Will have to look into the issue and resolve it.

Japanese characters in the TAGS page

Thanks for the great theme!
As I can see, in the TAGS page we have Japanese characters (see below) marking each entry for each tag. Is there a way to change to Latin characters or regular bullet points/numbers?