More Premium Hugo Themes Premium Hugo Themes

Obsidian To Hugo

Process Obsidian notes to publish them with Hugo. Supports transformation of Obsidian wiki links into Hugo shortcodes for internal linking.

Obsidian To Hugo

Process Obsidian notes to publish them with Hugo. Supports transformation of Obsidian wiki links into Hugo shortcodes for internal linking.

Author Avatar Theme by devidw
Github Stars Github Stars: 385
Last Commit Last Commit: Mar 21, 2023 -
First Commit Created: Dec 18, 2023 -
default image

Overview

This product is a lightweight, extensible, and zero-dependency CLI written in Python. Its purpose is to help publish obsidian notes with hugo. It only requires two arguments: the obsidian vault directory and the hugo content directory. The CLI takes care of several steps including clearing the hugo content directory, copying obsidian vault contents into the hugo content directory, and replacing obsidian wiki links with hugo shortcode links. Users can also write and register custom filters and processors to further customize the content processing.

Features

  • Lightweight, extensible, and zero-dependency CLI
  • Copies obsidian vault contents into hugo content directory
  • Replaces obsidian wiki links with hugo shortcode links
  • Replaces obsidian marks with HTML marks
  • Ability to write and register custom filters to include/exclude content
  • Ability to write custom processors to modify file contents

Installation

To install the obsidian-to-hugo CLI, follow these steps:

  1. Open your terminal.
  2. Install the package using pip: pip install obsidian-to-hugo
  3. Once installed, you can access the CLI by running obsidian-to-hugo in your terminal.

Summary

The obsidian-to-hugo CLI is a useful tool for publishing obsidian notes with hugo. It simplifies the process by automatically copying the obsidian vault contents into the hugo content directory and replacing obsidian wiki links with hugo shortcode links. Users can also customize the content processing by writing custom filters and processors. Overall, this CLI is a helpful companion for integrating obsidian and hugo workflows.