Process Obsidian notes to publish them with Hugo. Transforms Obsidian wiki links into Hugo shortcodes for internal linking.
Project description
Obsidian Vault to Hugo Content
Lightweight, zero-dependency CLI written in Python to help us publish obsidian notes with hugo.
It only takes two arguments: The obsidian vault directory (--obsidian-vault-dir
) and the hugo content directory (--hugo-content-dir
).
python -m obsidian_to_hugo --obsidian-vault-dir=<path> --hugo-content-dir=<path>
It takes care of the following steps:
- Clears hugo content directory (directory will be deleted and recreated)
- Copies obsidian vault contents into hugo content directory (
.obsidian
gets removed immediately after copying) - Replaces obsidian wiki links (
[[wikilink]]
) with hugo shortcode links ([wikilink]({{< ref "wikilink" >}})
)
Replacement examples
Obsidian | Hugo |
---|---|
[[/some/wiki/link]] |
[/some/wiki/link]({{< ref "/some/wiki/link" >}}) |
[[/some/wiki/link|Some text]] |
[Some text]({{< ref "/some/wiki/link" >}}) |
[[/some/wiki/link/_index]] |
[/some/wiki/link/]({{< ref "/some/wiki/link/" >}}) |
[[/some/wiki/link#Some Heading|Some Heading Link]] |
[Some Heading Link]({{< ref "/some/wiki/link#some-heading" >}}) |
NOTE: For now, there is no way to escape obsidian wiki links. Every link will be replaced with a hugo link. The only way to get around this is changing the wiki link to don't match the exact sytax, for example by adding an invisible space (Obsidian will highlight the invisible character as a red dot).
However, this still is really really not best practice, so if anyone wants to implement real escaping, please do so.
Installation
pip install obsidian-to-hugo
Usage
usage: __main__.py [-h] [--hugo-content-dir HUGO_CONTENT_DIR] [--obsidian-vault-dir OBSIDIAN_VAULT_DIR]
options:
-h, --help show this help message and exit
--hugo-content-dir HUGO_CONTENT_DIR
Directory of your Hugo content directory, the obsidian notes should be processed into.
--obsidian-vault-dir OBSIDIAN_VAULT_DIR
Directory of the Obsidian vault, the notes should be processed from.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for obsidian_to_hugo-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bdbe47bfc09156b6229d0500eee16822086435e0c974722751f180c348d9eb3 |
|
MD5 | 65471bc68878183e896a5f5e1ae28d2d |
|
BLAKE2b-256 | 9a270927131d59eddd8f242f20d6374e3048a4df1117612a6b460d86286c1c28 |