Coder Social home page Coder Social logo

obsidian-meets-hugo's Introduction

This fork

In this fork I fix things I need for my own website, https://serhii.net, posts for which are also written in Obsidian. Specifically, this fixes:

  • Use Obsidian file front-matter title if present (instead of the filename)
  • Allow writing directly to site root with empty --sub-path= by fixing double-leading-slash assets-linking bug
  • Cyrillc now allowed in filenames
  • Leave _index.md as-is without renaming them to -index.md โ€” that way these files can be created directly in Obsidian instead of manually in Hugo

This is literally my first 2h coding something in Go with which I'm completely unfamiliar, so YMMV and be careful :)


codecov

omh - Obsidian Meets Hugo

Command line tool to marry Obsidian vaults to Hugo published websites.

# convert and copy all obsidian notes in directory (and sub-directories)
#  into hugo path in `/path/to/hugo/content/obsidian` and respective static
#  files into `/path/to/hugo/static/obsidian`
$ omh \
    --obsidian-root /path/to/obsidian \
    --hugo-root /path/to/hugo

See omh -h for extended options.

Note: on Mac you can find your iCloud synced notes in ~/Library/Mobile\ Documents/iCloud\~md\~obsidian/Documents/

Install

$ go install github.com/ukautz/obsidian-meets-hugo/cmds/omh

Use-Case

This command line tool allows you to easily export an Obsidian vault, or a sub-set thereof, into a Hugo published website.

I am using this tool to publish my own notes - that follow a standard in between Zettelkasten and Wikipedia - to my Blog, as you can see here: https://ulrichkautz.com/zettel/. This way I have them easily available and can reference them in Blog entries.

License

MIT

Alternatives

Things I found that do not exactly fit my needs, but maybe yours:

obsidian-meets-hugo's People

Contributors

ukautz avatar pchr8 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.