It only takes two arguments: The obsidian vault directory (--obsidian-vault-dir
) and the hugo content directory (--hugo-content-dir
).
python path/to/obsidian-to-hugo/src --obsidian-vault-dir=<path> --hugo-content-dir=<path>
The program will take 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 links ([wikilink]({{< ref "wikilink" >}})
)
Obsidian | Hugo |
---|---|
|
|
|
|
|
|
ℹ️
|
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 red dot).![]() However, this still is really really not best practice, so if anyone wants to implement real escaping, please do so. |
usage: path/to/obsidian-to-hugo/src [-h] [--hugo-content-dir HUGO_CONTENT_DIR] [--obsidian-vault-dir OBSIDIAN_VAULT_DIR]
optional arguments:
-h, --help show this help message and exit
--hugo-content-dir HUGO_CONTENT_DIR
The hugo content directory path, the obsidian contents get placed.
--obsidian-vault-dir OBSIDIAN_VAULT_DIR
The directory of the Obsidian vault you would like to process.