{"id":13770677,"url":"https://github.com/notkmhn/obyde","last_synced_at":"2025-05-11T03:32:51.208Z","repository":{"id":44943837,"uuid":"335530232","full_name":"notkmhn/obyde","owner":"notkmhn","description":"A minimal tool to convert a \"standardly\" configured Obsidian vault to a Jekyll or Hugo blog.","archived":false,"fork":false,"pushed_at":"2022-02-21T10:20:45.000Z","size":66,"stargazers_count":67,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-25T03:15:23.670Z","etag":null,"topics":["hugo","hugo-blog","jekyll","jekyll-blog","obsidian","obsidian-md","obsidian-vault"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/notkmhn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-03T06:32:39.000Z","updated_at":"2025-04-11T12:27:00.000Z","dependencies_parsed_at":"2022-09-04T22:31:00.222Z","dependency_job_id":null,"html_url":"https://github.com/notkmhn/obyde","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notkmhn%2Fobyde","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notkmhn%2Fobyde/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notkmhn%2Fobyde/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notkmhn%2Fobyde/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/notkmhn","download_url":"https://codeload.github.com/notkmhn/obyde/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252949272,"owners_count":21830151,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hugo","hugo-blog","jekyll","jekyll-blog","obsidian","obsidian-md","obsidian-vault"],"created_at":"2024-08-03T17:00:40.536Z","updated_at":"2025-05-11T03:32:50.930Z","avatar_url":"https://github.com/notkmhn.png","language":"Python","funding_links":[],"categories":["Publishing","Python"],"sub_categories":[],"readme":"# obyde\n\nA minimal tool to convert a \"standardly\" configured [Obsidian](https://obsidian.md/) vault to a Jekyll or Hugo blog.\n\n## Installation\nInstall obyde using `pip`:\n\n```sh\npip install git+https://github.com/khalednassar/obyde\n```\n\nOr using `pipenv`:\n\n```sh\npipenv install git+https://github.com/khalednassar/obyde#egg=obyde\n```\n\n## Caveat\n`obyde` is mainly meant to support easy \"default\" Obsidian vault to Jekyll or Hugo _blog_ conversions and it does so in an opinionated way. In order to create posts in an easy fashion, it requires that post filenames have a \"post date\", this is mainly to align with Jekyll, but it is also nice to use for Hugo.\nThis is done by utilizing frontmatter in the Obsidian markdown notes, which means that each note must have a frontmatter section with at least a date key-value pair as such:\n```md\n---\ndate: 2021-02-13\n\n---\n```\nAdditionally, currently only dates of the format `YYYY-MM-DD` are supported.\n\n## Usage\nCopy the `config.yaml.sample` file and change the paths to align with your set up or copy this sample configuration:\n\n```yaml\nvault:\n        path: \"/path/to/vault/root/\" # Path to the Obsidian vault root. Markdown file discovery will start at this directory recursively.\n        asset_path: \"/path/to/vault/attachments/\" # Path to the Obsidian vault attachments folder\n        excluded_subdirectories: # Optional: list of excluded subdirectories of the Obsidian vault root\n                - .trash\noutput:\n        post_output_path: \"/path/to/jekyll/_posts/\" # Path to the Jekyll or Hugo posts directory\n        asset_output_path: \"/path/to/jekyll/assets/\" # Path to the blog assets directory, copied from the Obsidian attachments folder\n        relative_asset_path_prefix: \"{{ site.blog_assets_location }}\" # Optional: a relative URL prefix for blog assets without a trailing slash. Can also be a liquid template substitution for Jekyll.\n        post_link_mode: \"jekyll\" # Optional, values can be either \"jekyll\" or \"hugo\" and the default is \"jekyll\". Sets the way post references are output.\n```\n\nWrite your posts in the Obsidian vault then move the vault to the configured Jekyll or Hugo blog directory using\n```sh\nobyde -c \u003cpath to config.yaml\u003e\n``` \n\n### Options\n**Regex-based find and replace transformations**: (see PR [#1](https://github.com/khalednassar/obyde/pull/1)) can be done through the frontmatter by specifying a `find` regex list and a corresponding `replace` string list of the same length. Each `find` regex will be compiled to search and replace matching instances with the string that is at the same index in the `replace` list.\n\nFor example, the following frontmatter configuraiton will replace every instance of `foo` with `baz` and every instance of `bar` and `bak` with `qux`:\n```yaml\n---\nfind:\n  - foo\n  - ba(r|k)\nreplace:\n  - baz\n  - qux\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotkmhn%2Fobyde","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotkmhn%2Fobyde","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotkmhn%2Fobyde/lists"}