{"id":27528658,"url":"https://github.com/peter88213/zim2obsidian","last_synced_at":"2025-04-18T16:38:41.265Z","repository":{"id":159275459,"uuid":"634559226","full_name":"peter88213/zim2obsidian","owner":"peter88213","description":"Post-process Zim Markdown export for use with Obsidian.","archived":false,"fork":false,"pushed_at":"2025-03-22T19:16:09.000Z","size":114,"stargazers_count":13,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-22T20:23:51.021Z","etag":null,"topics":["markdown","obsidian","python","zim"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/peter88213.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-30T14:27:50.000Z","updated_at":"2025-03-22T19:16:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"d68c34a4-d38d-4687-b887-7a5b1e0e5b4a","html_url":"https://github.com/peter88213/zim2obsidian","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter88213%2Fzim2obsidian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter88213%2Fzim2obsidian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter88213%2Fzim2obsidian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter88213%2Fzim2obsidian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peter88213","download_url":"https://codeload.github.com/peter88213/zim2obsidian/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249518382,"owners_count":21284976,"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":["markdown","obsidian","python","zim"],"created_at":"2025-04-18T16:38:39.877Z","updated_at":"2025-04-18T16:38:41.235Z","avatar_url":"https://github.com/peter88213.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zim2obsidian\r\n\r\nPost-process Zim Markdown export for use with Obsidian.\r\n\r\n\r\n## Features\r\n\r\nLoops through all subdirectories of a *Zim* notebook Markdown export.\r\n\r\n- Renames pages according to the names given by the top first level heading.\r\n- Removes each note's first line. \r\n- Converts Markdown links to wikilinks (optional).\r\n- Converts several Markdown formattings to Obsidian style:\r\n    - Replaces Setext-style headers with Atx-style headers.\r\n    - Converts horizontal rulers.\r\n    - Converts highlighting.\r\n    - Converts checkboxes.\r\n    - Converts tags.\r\n    - Converts verbatim blocks to \"fenced\" code blocks.\r\n    \r\n\r\n## Requirements\r\n\r\n- A Python installation (version 3.9 or newer).\r\n\r\n\r\n## Download\r\n\r\nSave the file [zim2obsidian.py](https://raw.githubusercontent.com/peter88213/zim2obsidian/main/src/zim2obsidian.py).\r\n\r\n\r\n## Suggested workflow\r\n\r\n1. If you use indentiation in your *Zim* notebook, consider running the **subst_indent.py** tool first. \r\n2. Have *Zim* export the notebook to Markdown (export each page to a separate file). \r\n3. Make sure the Markdown files have the \".md\" extension. If not, run the **markdown2md.py** tool first.\r\n4. If you have substituted indentiation with the **subst_indent.py** preprocessor, run the **indent_md.py** tool now.\r\n5. Copy **zim2obsidian.py** into the export root directory. \r\n6. Start it by double clicking on it or from the console. \r\n\r\n\r\n## Usage of the zim2obsidian.py script\r\n\r\n```\r\nusage: zim2obsidian.py [-h] [-b] [-w] [-@]\r\n\r\nPost-process Zim Markdown export for use with Obsidian\r\n\r\noptions:\r\n  -h, --help       show this help message and exit\r\n  -b, --backticks  verbatim blocks and inline code are marked with backticks\r\n  -w, --wikilinks  Convert internal Markdown links to wikilinks\r\n  -@, --preserve_at  Do not convert Zim tags to Obsidian tags\r\n```\r\n\r\n### The \"backticks\" option explained\r\n\r\n*Zim* exports \"verbatim\" blocks indented with tabs.\r\nBy default, *zim2obsidian.py* encloses such blocks with three backticks, \r\nso that *Obsidian* recognizes them as code blocks.\r\nInline code markup is not supported by regular *Zim*.\r\n\r\nHowever, you can enclose inline code with backticks in *Zim*, and\r\n\"fence\" code blocks with three backticks, as usual in GitHub flavored markdown. \r\nThen you can call *zim2obsidian.py* with the `--backticks` argument. \r\nThe script then keeps the backticks-enclosed passages verbatim. \r\nLeading tabs are passed through without adding code block markers.\r\n \r\n---\r\n\r\n## Feedback? Ideas? Feature requests?\r\n\r\nBe aware, this is open source software, and you can implement your own features either locally\r\nafter downloading and unpacking the [latest release](https://github.com/peter88213/zim2obsidian/releases/latest), \r\nor in your own fork.\r\n\r\nYou also can go to the [\"discussions\" forum](https://github.com/peter88213/zim2obsidian/discussions) \r\nto discuss your idea.\r\n\r\n\r\n------------\r\n\r\n## License\r\n\r\nPublished under the [MIT License](https://opensource.org/licenses/mit-license.php)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeter88213%2Fzim2obsidian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeter88213%2Fzim2obsidian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeter88213%2Fzim2obsidian/lists"}