Repository files navigation

Lightweight, extensible, zero-dependency CLI written in Python to help us publishObsidian notes withHugo.

My Obsidian vault and my Hugo site are two completely different systems with wildly different directory structures. I do all of my writing in Obsidian and simply use Hugo as a place to publish that writing. As such, I wanted a tool that updated my Hugo content that is driven entirely by changes made in my Obsidian vault.

This tool directly copies specified directories into Hugocontent folder, maintaining the directory structure in the process. It flattens the rest of the vault and dumps into acontent/writing directory all while maintaining leaf bundles.

• Clears Hugo content directory
• Copies Obsidian vault contents into Hugo content directory
• Maintains folder structure for directories you specify
• Flattens and dumps all other notes tocontent/writing
• Maintains all notes as Hugo leaf bundles
• Deletes all file types except formd files and images that are within a leaf bundle
• Replaces Obsidian wiki links ([[wikilink]]) with Hugo shortcode links([wikilink]({{< ref "wikilink" >}}))
• Replaces Obsidian image wiki links (![[some_image.jpg]]) with Hugo shortcode links ({{< image some_image.jpg \>}})
• Replaces obsidian marks (==important==) with HTML marks (<mark>important</mark>)
• Removes imported Kindle highlights under any## Highlights header
• Want to do more? You can write and register customfilters to dynamicallyinclude/exclude content from processing andprocessors to do whateveryou want with the file contents.

NoteFor now, there isno way to escape obsidian wiki links. Every linkwill be replaced with a hugo link. The only way to get around this is changingthe wiki link to don't match the exact sytax, for example by adding aninvisible space (Obsidian will highlight the invisible character as a red dot).However, this still is really reallynot bestpractice, so if anyone wants to implement real escaping,please doso.

Obsidian structure must followHugo leaf bundle structure. If a note contains images, put the note and all images in the same folderwith the note being named index.md to maintain leaf bundles and associated images.

For now, clone the project and install locally.

git clone https://github.com/Westley-Winks/obsidian-to-hugo.gitcd obsidian-to-hugomake install_locally

usage: __main__.py [-h] [--version] [--hugo-content-dir HUGO_CONTENT_DIR]                   [--obsidian-vault-dir OBSIDIAN_VAULT_DIR]options:  -h, --help            show this help message and exit  --version, -v         Show the version 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.

This file goes in your Hugo site inscripts.

fromobsidian_to_hugoimportObsidianToHugoobsidian_to_hugo=ObsidianToHugo(obsidian_vault_dir="path/to/obsidian/vault",hugo_content_dir="path/to/hugo/content",)obsidian_to_hugo.run()

You can pass an optionalfilters argument to theObsidianToHugoconstructor. This argument should be a list of functions.

The function will be invoked for each file from the obsidian vault that iscopied into the hugo content directory.

Inside the function, you have access to the file path and the file contents.

When the function returnsFalse, the file will be skipped and not copiedinto the hugo content directory.

fromobsidian_to_hugoimportObsidianToHugodeffilter_file(file_contents:str,file_path:str)->bool:# do something with the file path and contentsifyour_condition:returnTrue# copy fileelse:returnFalse# skip fileobsidian_to_hugo=ObsidianToHugo(obsidian_vault_dir="path/to/obsidian/vault",hugo_content_dir="path/to/hugo/content",filters=[filter_file],)obsidian_to_hugo.run()

You can pass an optionalprocessors argument to theObsidianToHugoconstructor. This argument should be a list of functions.

The function will be invoked for each file from the obsidian vault that iscopied into the hugo content directory. It will be passed the file contentsas string, and should return the processed version of the file contents.

Custom processors are invoked after the default processing of the file contents.

fromobsidian_to_hugoimportObsidianToHugodefprocess_file(file_contents:str)->str:# do something with the file contentsreturnfile_contentsobsidian_to_hugo=ObsidianToHugo(obsidian_vault_dir="path/to/obsidian/vault",hugo_content_dir="path/to/hugo/content",processors=[process_file],)obsidian_to_hugo.run()

For the directories that you want to copy the exact structure of and put intocontent as is, add thedirect_copies argument to theObsidianToHugo constructor. This should be a list of paths to the directories in your obsidian vault.

This will put the same structure into a directory of the same name incontent in your Hugo site.

fromobsidian_to_hugoimportObsidianToHugoobsidian_to_hugo=ObsidianToHugo(obsidian_vault_dir="path/to/obsidian/vault",hugo_content_dir="path/to/hugo/content",direct_copies= ["path/to/direct/copy/folder"])obsidian_to_hugo.run()

For the sensitive directories that you don't wantobsidian-to-hugo to look at, add thecopy_exclusions argument to theObsidianToHugo constructor. This should be a list of directory names.obsidian-to-hugo will skip these entirely during the copy step.

fromobsidian_to_hugoimportObsidianToHugoobsidian_to_hugo=ObsidianToHugo(obsidian_vault_dir="path/to/obsidian/vault",hugo_content_dir="path/to/hugo/content",copy_exclusions= ["folders","to","skip"])obsidian_to_hugo.run()

This project is geared to my own specific use case and I kind of built it just for me. However, if you have some ideas to make it more robust and generally useful please submit a pull request.

This is a direct fork fromDavid Wolf's obsidian-to-hugo project. Huge thank you to them for doing most of the work. Check out theirreally cool website while you are at it.