tanner/pelican-obsidian
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
19 Commits 1 Branch 0 Tags 42 KiB
Python 100%
7ee02b03d1
Go to file
Tanner Collin 7ee02b03d1 Include "/" in empty paths 
When articles were in the base directory, the string replacement:
`str(full_path).replace(str(base_path) + '/'`
would not match, causing the whole absolute path to be included which
would break the link.

This should now work if the article is in the base directory or in any
subfolder.
2022-04-22 15:34:27 -06:00
.github Create FUNDING.yml 2021-07-04 15:48:58 +02:00
pelican/plugins/obsidian Include "/" in empty paths 2022-04-22 15:34:27 -06:00
.gitignore pip et al don't handle metadata for pyproject.toml yet 2021-07-05 09:46:56 +02:00
LICENSE Add license 2021-07-03 19:28:44 +02:00
pyproject.toml pip et al don't handle metadata for pyproject.toml yet 2021-07-05 09:46:56 +02:00
README.md Pip install via git repo. 2021-07-05 12:34:45 +02:00
setup.cfg Try without package_dir 2021-07-05 10:13:12 +02:00
setup.py pip et al don't handle metadata for pyproject.toml yet 2021-07-05 09:46:56 +02:00

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

Usage

Install the plugin as described in the pelican documentation.

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.

The backlinks in Obsidian follows this format [[ document | Actual link name ]] The actual link name is optional.

To specify the location of an attachment the following syntax is used ![[ filename.jpg ]]. 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.