bridgetown_obsidian 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '028ac3f5309759bc586703cf604625546143e23100c377dc20f6434ab0d3df00'
+  data.tar.gz: a3e2c3d44f5c5450a730cc4cbcd9efa5f89c8d4e3baf17c11d657d712c7c3d71
+SHA512:
+  metadata.gz: 1b1416069c4deb82230388cf3a05605adabdca7146424624e801074b38519f8285d82babbd6baf9ddba6b322e3aa51be1ba7a176479715418da271f4127b07c5
+  data.tar.gz: 212fe62a78ac8d002d65967011a42cd373ea522ce92effa1db4652c3e5a7f20886730d5a624d2e1f1043ef9c1373c781b90b31ba9d6d7c82780f562d8dbd908f

data/.gitignore

@@ -0,0 +1,41 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+test/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack
+
+.env
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+  Exclude:
+    - .gitignore
+    - .rubocop.yml
+    - "*.gemspec"
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+    - Rakefile
+    - bridgetown.automation.rb
+
+    - script/**/*
+    - test/fixtures/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+- ...
+
+## [0.1.0] - YYYY-MM-DD
+
+- First version

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+
+group :test do
+  gem "minitest"
+  gem "minitest-profile"
+  gem "minitest-reporters"
+end
+
+group :development do
+  gem "standard"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+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,61 @@
+# Bridgetown Obsidian Plugin
+
+A Bridgetown plugin to convert Obsidian notes to Bridgetown posts.
+
+This plugin allows you to use Obsidian's [internal links](https://help.obsidian.md/Linking+notes+and+files/Internal+links) feature to cross reference your Bridgetown posts and [embed images](https://help.obsidian.md/Linking+notes+and+files/Embedding+files). It replaces all the wikilinks references in `src/_posts` with Bridgetown compatible versions:
+
+1. Converts wikilinks from `[[My Markdown Post]]` to `<a href="/my-markdown post/">My Markdown Post</a>`
+2. Supports optional link titles such as `[[My Markdown Post|with an optional title]]`
+3. Converts image references from `![[attachments/image.jpg]]` to `<img src="/attachments/bridge.jpg" alt="" />`
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+bundle add bridgetown_obsidian
+```
+
+Then add the initializer to your configuration in `config/initializers.rb`:
+
+```ruby
+init :bridgetown_obsidian
+```
+
+### Obsidian Setup
+
+There are two main ways you can use this plugin with obsidian.
+
+1. Create a new vault that points to your `src/_posts` folder in Bridgetown. In this case you might want to add `.obsidian` to your `.gitignore` file.
+
+2. Create an symbolink link in your existing vault to your Bridgetown folder. This option is [strongly advised against](https://help.obsidian.md/Files+and+folders/Symbolic+links+and+junctions) by Obsidian so use at your own risk.
+
+```shell
+ln -s /path/to/bridgetown/folder/src/_posts "My Blog"
+```
+
+In either case, turn on `Use [[Wikilinks]]` option in [Files & Links settings](https://help.obsidian.md/Linking+notes+and+files/Internal+links).
+
+## Usage
+
+Edit your posts in Obsidian. If you have a Bridgetown server running, you can see your changes in real-time. If not, your changes will get reflected the next time you build your site.
+
+## Testing
+
+- Run `bundle exec rake test` to run the test suite.
+
+## Credits
+
+Check out these other great plugins that helped to inspire this one:
+
+- https://github.com/SpinalCMS/bridgetown-internal-markdown-links
+- https://github.com/jamie/bridgetown-notable
+
+## Contributing
+
+1. Fork it (https://github.com/username/my-awesome-plugin/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task default: :test

data/bridgetown.automation.rb

@@ -0,0 +1,51 @@
+# If your plugin requires a lot of steps to get set up, consider writing an automation to help guide users.
+# You could set up and configure all sorts of things, for example:
+#
+# add_gem("my_plugin")
+#
+# add_yarn_for_gem("my_plugin")
+#
+# add_initializer :"my_plugin" do
+#   <<~RUBY
+#     do
+#       some_config_key 12345
+#     end
+#   RUBY
+# end
+#
+# create_builder "my_nifty_builder.rb" do
+#   <<~RUBY
+#     class MyNeatBuilder < SiteBuilder
+#       def build
+#         puts MyPlugin.hello
+#       end
+#     end
+#   RUBY
+# end
+#
+# javascript_import do
+#   <<~JS
+#     import { MyPlugin } from "my_plugin"
+#   JS
+# end
+#
+# javascript_import 'import "my_plugin/frontend/styles/index.css"'
+#
+# create_file "src/_data/plugin_data.yml" do
+#   <<~YAML
+#     data:
+#       goes: here
+#   YAML
+# end
+#
+# color = ask("What's your favorite color?")
+#
+# append_to_file "bridgetown.config.yml" do
+#   <<~YAML
+#
+#     my_plugin:
+#       favorite_color: #{color}
+#   YAML
+# end
+#
+# Read the Automations documentation: https://www.bridgetownrb.com/docs/automations

data/bridgetown_obsidian.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown_obsidian/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "bridgetown_obsidian"
+  spec.version = BridgetownObsidian::VERSION
+  spec.author = "Onur Ozer"
+  spec.email = "onur@simplematters.dev"
+  spec.summary = "Converts Obsidian notes to Bridgetown posts"
+  spec.homepage = "https://github.com/onurozer/bridgetown_obsidian"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|script|spec|features|frontend)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_dependency "bridgetown", ">= 1.2.0", "< 2.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
+end

data/lib/bridgetown_obsidian/builder.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module BridgetownObsidian
+  class Builder < Bridgetown::Builder
+    REGEX_WIKILINK = /(?<!!)\[\[([^\]]+?)(?:\|([^\]]+))?\]\]/
+    REGEX_IMAGES = /!\[\[(.+?)\]\]/
+
+    def build
+      generator :wikilinks
+      generator :images
+    end
+
+    def wikilinks
+      resources.each do |post|
+        post.content.gsub!(REGEX_WIKILINK) do |match|
+          wikilink = Regexp.last_match(1)
+          wikilink_title = Regexp.last_match(2) || wikilink
+          "[#{wikilink_title}](#{url_for("_posts/#{wikilink}.md")})"
+        end
+      end
+    end
+
+    def images
+      resources.each do |post|
+        post.content.gsub!(REGEX_IMAGES) do |match|
+          image = Regexp.last_match(1)
+          "![](/#{image})"
+        end
+      end
+    end
+
+    private
+
+    def resources
+      site.collections.posts.resources
+    end
+
+    def url_for(url)
+      Bridgetown::RubyTemplateView::Helpers.new(resource, site).url_for(url)
+    end
+  end
+end

data/lib/bridgetown_obsidian/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BridgetownObsidian
+  VERSION = "0.1.0"
+end

data/lib/bridgetown_obsidian.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "bridgetown_obsidian/builder"
+
+# @param config [Bridgetown::Configuration::ConfigurationDSL]
+Bridgetown.initializer :bridgetown_obsidian do |config|
+  # Add code here which will run when a site includes
+  # `init :bridgetown_obsidian`
+  # in its configuration
+
+  # Add default configuration data:
+  config.bridgetown_obsidian ||= {}
+  # config.bridgetown_obsidian.collections ||= ['_posts']
+
+  # Register your builder:
+  config.builder BridgetownObsidian::Builder
+
+  # You can optionally supply a source manifest:
+  # config.source_manifest(
+  #   origin: BridgetownObsidian,
+  #   components: File.expand_path("../components", __dir__),
+  #   layouts: File.expand_path("../layouts", __dir__),
+  #   content: File.expand_path("../content", __dir__)
+  # )
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown_obsidian
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Onur Ozer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description:
+email: onur@simplematters.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown.automation.rb
+- bridgetown_obsidian.gemspec
+- lib/bridgetown_obsidian.rb
+- lib/bridgetown_obsidian/builder.rb
+- lib/bridgetown_obsidian/version.rb
+homepage: https://github.com/onurozer/bridgetown_obsidian
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Converts Obsidian notes to Bridgetown posts
+test_files: []