Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonathan-s/pelican-obsidian
Makes it possible to bridge work in obsidian to pelican seamlessly
https://github.com/jonathan-s/pelican-obsidian
obsidian obsidian-md pelican-plugin pelican-plugins
Last synced: 11 days ago
JSON representation
Makes it possible to bridge work in obsidian to pelican seamlessly
- Host: GitHub
- URL: https://github.com/jonathan-s/pelican-obsidian
- Owner: jonathan-s
- License: mit
- Created: 2021-07-03T11:37:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T12:09:01.000Z (2 months ago)
- Last Synced: 2024-10-12T07:34:50.716Z (27 days ago)
- Topics: obsidian, obsidian-md, pelican-plugin, pelican-plugins
- Language: Python
- Homepage:
- Size: 34.2 KB
- Stars: 36
- Watchers: 5
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-obsidian - pelican-obsidian - s) | (Publishing)
- jimsghstars - jonathan-s/pelican-obsidian - Makes it possible to bridge work in obsidian to pelican seamlessly (Python)
README
Obsidian: A Plugin for Pelican
============================
Obsidian is a pelican plugin that allows you to use the syntax used within Obsidian and when pelican then renders these posts it won't look weird or out of place.
Phrased differently, if you don't like that `#` is included in the name of the tag when you name it `#my-tag` and you think that internal pelican links are difficult to remember and would like to use `[[ my link ]]` as an internal link instead this plugin would be for you.
If the article doesn't exist it will return text only. That way, there is a possibility of clearly separating posts that should belong on the blog and linked as such vs posts that should only belong inside Obsidian.
Installation
------------
This plugin can be installed via:
# not yet on pypi, but when it is you can install it with.
pip install pelican-obsidian
# meanwhile you can install using this repo.
pip install git+git://github.com/jonathan-s/pelican-obsidian@main#egg=pelican-obsidian
Add `'obsidian'` to the `PLUGINS` list in your Pelican config:
```
PLUGINS = [
'obsidian',
]
```
Usage
-----
In the tags section you will be able to use `#` without that being reflected in the actual name of the tag. In other words.
```
Tags: #my-tag
# reflects as
my-tag in the html output.
```
Links follow this format:
```
[[note name]]
[[note name | custom link text]]
```
Files are similar:
```
![[photo.jpg]]
![[photo.jpg | custom alt text]]
```
They explain more about the syntax in the section on [how to embed files](https://help.obsidian.md/How+to/Embed+files)
Future features
---------------
- Embed files or sections as described [here](https://help.obsidian.md/How+to/Format+your+notes)
- Task list?
- Support .rst?
- don't generate links for drafts
Implemented Features
-----------------
- Apply the same linking for pages.
License
-------
This project is licensed under the MIT license.