jekyll-obsidian 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d080f763648a7d4d15eb6b5b65d41dc7e22c4f4030366fd7f11ab75a52b421ab
+  data.tar.gz: 4ef6b231668c6442cd2d36d7c595fe507f9a029ecd7767fe2997e6231416bb22
+SHA512:
+  metadata.gz: fc15afa41dec63f364dba5b3657ec499c8fbc95425964a71a781cad7305f4dfbe0d05923d0e42d94caf92e6127229933ca9cdd9290983351172a60c1fea2df41
+  data.tar.gz: '084533f538cb36977c5e4c24bc0bf988a9c736031a862d6c8a2829c5d88784e08506328d984b26279dddebbd89bcaabb98d6bb1fe3467533f37409f0cc03f920'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+## [Unreleased]
+
+## [1.1.2] - 2024-09-13
+- Fixed duplicate linked mentions
+- Added text color to linked mention
+- Improved mobile explorer dock touch events
+
+## [1.1.1] - 2024-09-12
+- Removed jekyll hook on post write
+
+## [1.1.0] - 2024-09-12
+- Fixed parsing of backlinks from renamed .md files
+
+## [1.0.10] - 2024-09-12
+- Fixed parsing of generated JSON files
+
+## [1.0.9] - 2024-09-12
+- Site data generated as json files saved into _data
+
+## [1.0.8] - 2024-09-12
+- Renamed .md to .mdnote so jekyll do not generate pages from it
+
+## [1.0.6] - 2024-09-12
+- Moved EXPLORER and FILE_TREE to explorer.html
+
+## [1.0.5] - 2024-09-12
+- Removed VAULTPATH and VAULT_FILES from global constants
+
+## [1.0.4] - 2024-09-12
+- Moved const initialization outside of head with defer attribte (again)
+
+## [1.0.3] - 2024-09-12
+- Fixed loading-spinner style
+- Updated README
+
+## [1.0.2] - 2024-09-12
+- Turned off overwriting for generated html files
+- Moved const variable declarators to head
+
+## [1.0.1] - 2024-09-12
+- Added `defer` attribute to script body responsible for initialization of constant variables
+
+
+## [1.0.0] - 2024-09-11
+- Initial release
+
+
+## [0.1.0] - 2024-05-17
+- Project started

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at khiemgluong@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Khiem Luong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# jekyll-obsidian
+
+**View <a href="https://obsidian.md/" target="_blank">Obsidian</a> vaults, on your <a href="https://jekyllrb.com/" target="_blank">Jekyll</a> website.**
+
+![jekyll-obsidian](./screenshots/jekyll-obsidian.png)
+
+jekyll-obsidian is designed to emulate as much of Obsidian's original look and feel, allowing your Obsidian vaults to be hosted on a static Jekyll site.
+
+It should work out of the box if you use the default `minima` theme. Otherwise, you can modify the generated obsidian.scss and its partials. These .scss files are not overwritten when the site is served, and if you want to reset the styles, simply delete that modified .scss file and the gem will regenerate the default one.
+
+Thank you to the developers of <a href="https://github.com/cure53/DOMPurify" target="_blank">DOMPurify</a>, <a href="https://github.com/js-cookie/js-cookie" target="_blank">js-cookie</a> (for saving color scheme), <a href="https://github.com/markdown-it/markdown-it" target="_blank">markdown-it</a> (for parsing `.md` notes), and <a href="https://github.com/jonobr1/two.js" target="_blank">two.js</a> (for drawing `.canvas` node edges).
+
+# Features
+This Jekyll plugin has all the core features of Obsidian, including:
+- Backlinks
+- Embeds
+- Callouts
+- Linked mentions
+- Canvas
+- File search
+- Color schemes
+- Mobile support
+
+Some creative liberties were taken. For example, clicking on an image file will open a modal displaying it instead.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add jekyll-obsidian
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install jekyll-obsidian
+
+## Setup
+
+1. Add the following to your site's `_config.yml`:
+    ```yml
+    plugins:
+        - jekyll-obsidian
+    ```
+2. Drop your Obsidian vault folder into your site, make sure to remove the .git folder and .gitignore file
+3. Create a .markdown front matter file using the generated layout
+    ```yml
+    ---
+    layout: obsidian
+    title: Your Obsidian Vault
+    permalink: /your-obsidian-vault/
+    ---
+    ```
+4. Add `gem 'jekyll-obsidian'` into your site's Gemfile, preferably within `group :jekyll_plugins`
+    ```ruby
+    group :jekyll_plugins do
+    gem 'jekyll-obsidian'
+    end
+    ```
+
+5. In your `_config.yml`, set `obsidian_vault` to the root of the Obsidian vault
+    ```ruby
+    obsidian_vault: "Your Obsidian Vault"
+    obsidian_vault: "vaults/Another Obsidian Vault"
+    ```
+6. Run `bundle install` or `bundle update jekyll-obsidian`, if you already installed it
+
+7. Run `bundle exec jekyll build` to generate the necessary `.css` and `.json` files, and convert all your `.md` notes to `.mdnote`.
+
+8. Run `bundle exec jekyll serve`, you should now see your Obsidian page at your given permalink
+
+## Options
+`obsidian_homepage`
+Sets the homepage for your obsidian vault
+```ruby
+obsidian_homepage: "homepage.mdnote"
+obsidian_homepage: "homecanvas.canvas"
+```
+
+`obsidian_backlinks`
+Enables or disables backlinks, defaults to true
+> obsidian_backlinks: false
+
+`obsidian_embeds`
+Enables or disables embeds, defaults to true
+> obsidian_embeds: false
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/khiemgluong/jekyll-obsidian. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jekyll-obsidian/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the jekyll-obsidian project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/khiemgluong/jekyll-obsidian/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/assets/css/obsidian.scss

@@ -0,0 +1,103 @@
+---
+---
+
+#obsidian {
+    --bg: light-dark(white, #1e1e1e);
+    --color-border: light-dark(#e0e0e0, #404040);
+    --color-button: light-dark(#606060, #a0a0a0);
+    --bg-tinted: light-dark(#f6f6f6, #181818);
+    --color-accent: #5f6ce9;
+    --color-accent-hover: #7a85eb;
+    --color-text: light-dark(#363636, #dadada);
+    --linked-mention-color: light-dark(#5f5f5f, #b0b0b0);
+    --linked-mention-hover: light-dark(#eaeaea, #333);
+    --explorer-button-hover: light-dark(#e4e4e4, #262626);
+    height: calc(100vh - 62px);//adjust the subtractor based on your header height
+    display: inherit;
+    width: 100%;
+    color: var(--color-text);
+
+    table {
+        th {
+            background-color: light-dark(#f0f0f0, #121212);
+            color: var(--color-text);
+        }
+
+        tr {
+            &:nth-child(2n) {
+                background-color: light-dark(#f7f7f7, #161616);
+            }
+        }
+    }
+
+    li {
+        &::before {
+            color: light-dark(#ababab, #656565);
+        }
+    }
+
+    >* {
+        height: initial;
+    }
+
+    #sidebar {
+        display: flex;
+        width: 2rem;
+        flex-direction: column;
+        align-items: flex-start;
+        background-color: var(--bg-tinted);
+        border-right: 1px solid var(--color-border);
+    }
+
+    #explorer {
+        overflow-y: auto;
+        max-height: 100vh;
+        width: 18%;
+        background-color: var(--bg-tinted);
+        overscroll-behavior: none;
+    }
+
+    #divider {
+        width: 3px;
+        border-left: 1px solid var(--color-border);
+        cursor: ew-resize;
+        position: relative;
+        transition: background-color 0.4s ease;
+        background-color: var(--color-border);
+
+        &:hover {
+            background-color: var(--color-accent);
+        }
+    }
+
+    #fileread {
+        flex: 1;
+        overflow-y: auto;
+        max-height: 100vh;
+        display: flex;
+        flex-direction: column;
+        align-items: center;
+        background-color: var(--bg);
+        position: relative;
+    }
+
+    &:has(input[name="color-scheme"][value="system"]:checked) {
+        color-scheme: light dark;
+    }
+
+    &:has(input[name="color-scheme"][value="light"]:checked) {
+        color-scheme: light;
+    }
+
+    &:has(input[name="color-scheme"][value="dark"]:checked) {
+        color-scheme: dark;
+    }
+}
+
+@import "obsidian/loading";
+@import "obsidian/modals";
+@import "obsidian/canvas";
+@import "obsidian/explorer";
+@import "obsidian/fileread";
+@import "obsidian/note";
+@import "obsidian/sidebar";

data/assets/css/partials/_canvas.scss

@@ -0,0 +1,62 @@
+#obsidian {
+    #fileread {
+        #canvas {
+            --canvas-backdrop: light-dark(rgba(200, 200, 200, 0.1),
+            rgba(100, 100, 100, 0.1));
+            position: absolute;
+            height: 10000px;
+            width: 10000px;
+            left: 0;
+            top: 0;
+            /* https://codepen.io/mapsandapps/pen/pbzooY */
+            background-color: var(--bg);
+            background-image: radial-gradient(rgb(108, 110, 112) 1%, transparent 0);
+            background-size: 15px 15px;
+
+            #canvas-content {
+                width: 100%;
+                height: 100%;
+                transform-origin: center center;
+                z-index: 5;
+            }
+
+            svg {
+                position: absolute;
+                z-index: 1;
+            }
+
+            .card {
+                box-sizing: border-box;
+                padding: .8rem;
+                padding-bottom: 0;
+                border-radius: .5rem;
+                border: 2px solid var(--color-border);
+                overflow: auto;
+
+                &.group {
+                    background-color: var(--canvas-backdrop);
+                    overflow: visible;
+
+                    p {
+                        position: relative;
+                        top: -64px;
+                        left: -16px;
+                        font-size: x-large;
+                        font-weight: bold;
+                        width: max-content;
+                        padding: 4px 12px;
+                        color: var(--color-text);
+                        background-color: var(--bg-tinted);
+                        border-radius: 0.8rem;
+                        border: 2px solid var(--color-border);
+                    }
+                }
+
+                &.text,
+                &.file {
+                    background-color: var(--bg);
+                }
+            }
+        }
+    }
+}

data/assets/css/partials/_explorer.scss

@@ -0,0 +1,128 @@
+#obsidian {
+    .hide-scrollbar {
+        -ms-overflow-style: none;
+        scrollbar-width: none;
+
+        &::-webkit-scrollbar {
+            display: none;
+        }
+    }
+
+    #vault-name {
+        margin-bottom: 3px;
+        padding: 2px 0;
+        font-weight: 500;
+        font-size: 1rem;
+        display: flex;
+        justify-content: space-between;
+        border-bottom: 1px solid var(--color-border);
+        position: sticky;
+        top: 0;
+        z-index: 5;
+        color: var(--color-text);
+        background-color: var(--bg-tinted);
+
+        #text {
+            padding-left: 4px;
+            white-space: nowrap;
+            overflow: hidden;
+            text-overflow: ellipsis;
+        }
+
+        #collapseExpand {
+            padding-right: 5px;
+            padding-top: 2px;
+            border: none;
+            background-color: transparent;
+        }
+    }
+
+    #file-tree {
+        position: relative;
+        &::-webkit-scrollbar {
+            display: none;
+        }
+
+        ul {
+            list-style-type: none;
+            padding-left: 0;
+            margin-left: 0;
+
+            button {
+                padding-left: 0;
+                vertical-align: middle;
+                user-select: none;
+                background: none;
+                border: none;
+                padding: 2px 5px;
+                margin: 0;
+                outline: none;
+                box-shadow: none;
+                font: inherit;
+                font-size: 0.9rem;
+                color: var(--color-button);
+                gap: 4px;
+                white-space: nowrap;
+                overflow: hidden;
+                text-overflow: ellipsis;
+                max-width: 100%;
+
+                svg {
+                    vertical-align: middle;
+                    margin-right: 4px;
+                    width: 100%;
+                    height: 100%;
+                    max-width: 16px;
+                    max-height: 16px;
+                }
+
+                span {
+                    vertical-align: middle;
+                }
+            }
+
+            ul {
+                li {
+                    &.file {
+                        padding-left: 12px;
+                        padding-top: 2px;
+
+                        &:not(:last-child) {
+                            border-left: 1px solid var(--color-border);
+                        }
+                    }
+                }
+            }
+
+            li {
+                &.file {
+                    margin-left: 12px;
+                    padding-bottom: 2px;
+
+                    &:hover {
+                        background-color: var(--explorer-button-hover);
+                        font-weight: bold;
+                    }
+                }
+
+                &.dir button:hover {
+                    background-color: var(--explorer-button-hover);
+                    font-weight: bold;
+                }
+            }
+        }
+
+        >ul>li.file {
+            margin-left: 14px;
+        }
+
+        ul li,
+        ul ul li {
+            padding-bottom: 2px;
+        }
+
+        ul ul li {
+            padding-left: 12px;
+        }
+    }
+}

data/assets/css/partials/_fileread.scss

@@ -0,0 +1,111 @@
+#obsidian {
+	#fileread {
+		button {
+			border: none;
+			background-color: transparent;
+		}
+
+		a:hover{
+			color: var(--color-text);
+		}
+
+		#breadcrumb {
+			list-style: none;
+			padding: 0;
+			z-index: 10;
+			color: var(--color-text);
+		}
+
+		ul#breadcrumb {
+			padding: 6px 0 3px 0;
+			margin: 0;
+			list-style: none;
+			position: sticky;
+			top: 0;
+			left: 0;
+			background-color: var(--bg);
+			width: 100%;
+			text-align: center;
+
+			li {
+				display: inline;
+				font-size: medium;
+			}
+
+			button {
+				display: inline;
+				font-size: medium;
+				color: var(--color-button);
+
+				&:hover {
+					color: var(--color-accent);
+				}
+			}
+
+			li+li {
+				&:before {
+					padding: 5px;
+					color: var(--color-text);
+					content: "/\00a0";
+				}
+			}
+		}
+
+		#note-content {
+			.url-link {
+				display: flex;
+				font-size: large;
+				color: var(--color-button);
+				padding-bottom: 0.5rem;
+			}
+
+			blockquote {
+				svg {
+					vertical-align: text-bottom;
+				}
+
+				.svg_Warning,
+				.svg_Question {
+					color: #ed7908;
+				}
+
+				.svg_Info,
+				.svg_Todo,
+				.svg_Note {
+					color: #086ddd;
+				}
+			}
+		}
+
+		.backlink {
+			color: var(--color-accent);
+			font-size: inherit;
+
+			&:hover {
+				color: var(--color-accent-hover);
+			}
+		}
+
+		.embed {
+			width: 100%;
+			max-width: 100%;
+			height: auto;
+			display: flex;
+			flex-direction: column;
+			align-items: center;
+
+			audio {
+				width: 80%;
+			}
+
+			p {
+				font-size: small;
+				color: var(--color-button);
+
+				&:hover {
+					color: var(--color-text);
+				}
+			}
+		}
+	}
+}