Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onurozer/bridgetown-obsidian
A Bridgetown plugin to convert Obsidian notes to Bridgetown posts.
https://github.com/onurozer/bridgetown-obsidian
bridgetown bridgetown-plugin obsidian
Last synced: 2 months ago
JSON representation
A Bridgetown plugin to convert Obsidian notes to Bridgetown posts.
- Host: GitHub
- URL: https://github.com/onurozer/bridgetown-obsidian
- Owner: onurozer
- License: mit
- Created: 2023-12-01T10:05:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-24T12:28:06.000Z (5 months ago)
- Last Synced: 2024-09-30T03:47:37.079Z (3 months ago)
- Topics: bridgetown, bridgetown-plugin, obsidian
- Language: Ruby
- Homepage:
- Size: 85.9 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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 `My Markdown Post`
2. Supports optional link titles such as `[[My Markdown Post|with an optional title]]`
3. Converts image references from `![[attachments/image.jpg]]` to `
`
## 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/onurozer/bridgetown-obsidian)
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