You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tanner Collin 41dd1d6491 Improve docs 4 months ago
.github Create FUNDING.yml 1 year ago
pelican/plugins/obsidian Allow more characters in file names 4 months ago
.gitignore pip et al don't handle metadata for pyproject.toml yet 1 year ago
LICENSE Add license 1 year ago
README.md Improve docs 4 months ago
pyproject.toml pip et al don't handle metadata for pyproject.toml yet 1 year ago
setup.cfg Try without package_dir 1 year ago
setup.py pip et al don't handle metadata for pyproject.toml yet 1 year ago

README.md

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

Future features

  • Embed files or sections as described here
  • Task list?
  • Support .rst?
  • don't generate links for drafts
  • Apply the same linking for pages.

License

This project is licensed under the MIT license.