# VimWiki To Org Mode 🦄
> Migration to Org mode, made a bit easier
## Install or update
```
pip install -U vimwiki-to-org
```
## What it does:
**Converts this:**
```
= Header1 =
== Header2 ==
=== Header3 ===
==== Heading4 ====
===== Heading5 =====
====== Heading6 ======
*bold text*
_italic text_
[[wiki_link]]
[[some wiki|description for some wiki file]]
* bullet list item 1
* bullet list item 2
1) numbered list item 1
2) numbered list item 2
{{{python
def greet(s):
print("Hello, " + s)
}}}
`echo "42"`
| a table | |
|---------|--|
| | |
{{file:./some-image.png}}
```
**To this:**
```
* Header1
** Header2
*** Header3
**** Heading4
***** Heading5
****** Heading6
*bold text*
/italic text/
[[file:wiki_link.org]]
[[some wiki.org][description for some wiki file]]
- bullet list item 1
- bullet list item 2
1) numbered list item 1
2) numbered list item 2
#+begin_src python
def greet(s):
print("Hello, " + s)
#+end_src
~echo "42"~
| a table | |
|---------|--|
| | |
[[file:./some-image.png]]
```
## Usage:
Launch via CLI
```
vimwiki_to_org
```
or
```
python -m vimwiki_to_org
```
## Help
```
vimwiki_to_org -h
usage: vimwiki_to_org [-h] [-d WIKI_PATH] [-o OUTPUT_PATH]
options:
-h, --help show this help message and exit
-d WIKI_PATH, --wiki-path WIKI_PATH
path to vimwiki directory (optional) (default: /home/USERNAME/vimwiki/)
-o OUTPUT_PATH, --output-path OUTPUT_PATH
path to output directory (optional) (default: PROJECT_DIR/converted_files/)
```
## Goals:
- Make it easier to migrate over existing VimWiki files to `.org` files
- Have a *reasonable* amount `.wiki` file content converted to it's `.org` equivalent (**at least** 60-70%) so there's less to manually edit.
## Features:
**Extend for your own situation:**
- The current config should be *good enough* for most basic VimWiki markdown, but **everyone's notes are different**.
- Configure the [regex](./vimwiki_to_org/src/converters/helpers/wiki_regex.py) and the [markdown replacements](./vimwiki_to_org/src/converters/helpers/org_markdown.py) for your specific situation.
**Your ~/vimwiki/ directory is safe:**
- Your `.wiki` files are **not modified**, just read.
- Regular files are not touched (`.png`, etc). **Those will have to be manually transferred**.
**Keep your linked pages:**
- Links between `.wiki` files are converted to link to their new `.org` pages.
```
[[SomeWikiPage]] -> [[file:SomeWikiPage.org]]
```
**Regex is applied by priority:**
- Headers, code blocks and links get handled first before converting text emphasis markdown
- This is to avoid accidentally converting things like:
- underscores used in a code block to italic text: `some_var_name -> some/var/name`
- file names with underscores converted to italic text: ```file:some_file_name.png -> file:some/file/name.png```
- etc, etc.
Raw data
{
"_id": null,
"home_page": "https://github.com/CryptoRodeo/VimWikiToOrg",
"name": "vimwiki-to-org",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "vimwiki orgmode convert",
"author": "Bryan Ramos",
"author_email": "Bryan Ramos <bryan.ramos@hey.com>",
"download_url": "https://files.pythonhosted.org/packages/1e/cd/3ba5fdb6be8658afc798d78bb14567eca4574f876489c6a77face05260da/vimwiki_to_org-1.2.0.tar.gz",
"platform": null,
"description": "# VimWiki To Org Mode \ud83e\udd84\n> Migration to Org mode, made a bit easier\n\n\n\n## Install or update \n\n```\npip install -U vimwiki-to-org\n```\n\n## What it does:\n\n**Converts this:**\n\n```\n= Header1 =\n== Header2 ==\n=== Header3 ===\n==== Heading4 ====\n===== Heading5 =====\n====== Heading6 ======\n\n*bold text*\n_italic text_\n\n[[wiki_link]]\n[[some wiki|description for some wiki file]]\n\n* bullet list item 1\n* bullet list item 2\n 1) numbered list item 1\n 2) numbered list item 2\n\n{{{python\ndef greet(s):\n print(\"Hello, \" + s)\n}}}\n\n`echo \"42\"`\n\n| a table | |\n|---------|--|\n| | |\n\n{{file:./some-image.png}}\n\n```\n\n**To this:**\n\n\n```\n* Header1 \n** Header2 \n*** Header3 \n**** Heading4 \n***** Heading5 \n****** Heading6 \n\n*bold text*\n/italic text/\n\n[[file:wiki_link.org]]\n[[some wiki.org][description for some wiki file]]\n\n- bullet list item 1\n- bullet list item 2\n 1) numbered list item 1\n 2) numbered list item 2\n\n#+begin_src python\ndef greet(s):\n print(\"Hello, \" + s)\n\n#+end_src\n\n~echo \"42\"~\n\n| a table | |\n|---------|--|\n| | |\n\n[[file:./some-image.png]]\n\n```\n\n## Usage:\n\nLaunch via CLI\n```\nvimwiki_to_org\n```\n\nor\n```\npython -m vimwiki_to_org\n```\n\n## Help\n```\nvimwiki_to_org -h\n\nusage: vimwiki_to_org [-h] [-d WIKI_PATH] [-o OUTPUT_PATH]\n\noptions:\n -h, --help show this help message and exit\n -d WIKI_PATH, --wiki-path WIKI_PATH\n path to vimwiki directory (optional) (default: /home/USERNAME/vimwiki/)\n -o OUTPUT_PATH, --output-path OUTPUT_PATH\n path to output directory (optional) (default: PROJECT_DIR/converted_files/)\n```\n\n## Goals:\n - Make it easier to migrate over existing VimWiki files to `.org` files\n - Have a *reasonable* amount `.wiki` file content converted to it's `.org` equivalent (**at least** 60-70%) so there's less to manually edit.\n \n## Features:\n\n**Extend for your own situation:**\n - The current config should be *good enough* for most basic VimWiki markdown, but **everyone's notes are different**.\n - Configure the [regex](./vimwiki_to_org/src/converters/helpers/wiki_regex.py) and the [markdown replacements](./vimwiki_to_org/src/converters/helpers/org_markdown.py) for your specific situation.\n\n**Your ~/vimwiki/ directory is safe:**\n- Your `.wiki` files are **not modified**, just read.\n- Regular files are not touched (`.png`, etc). **Those will have to be manually transferred**.\n\n**Keep your linked pages:**\n- Links between `.wiki` files are converted to link to their new `.org` pages.\n\n```\n[[SomeWikiPage]] -> [[file:SomeWikiPage.org]]\n```\n\n**Regex is applied by priority:**\n- Headers, code blocks and links get handled first before converting text emphasis markdown\n- This is to avoid accidentally converting things like:\n - underscores used in a code block to italic text: `some_var_name -> some/var/name`\n - file names with underscores converted to italic text: ```file:some_file_name.png -> file:some/file/name.png```\n - etc, etc.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Converts vimwiki files to org mode",
"version": "1.2.0",
"split_keywords": [
"vimwiki",
"orgmode",
"convert"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "88a658e61ce798f375b1e3497945761f",
"sha256": "401a47e47eeae3be406585881d29a646976d6521cdc0f7044d71119ea46f30f1"
},
"downloads": -1,
"filename": "vimwiki_to_org-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "88a658e61ce798f375b1e3497945761f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 27124,
"upload_time": "2022-12-08T13:48:09",
"upload_time_iso_8601": "2022-12-08T13:48:09.621182Z",
"url": "https://files.pythonhosted.org/packages/7c/29/3e60ce86a9e30d368fef5c9ac91d75a79f5fea81927a57552066a14be780/vimwiki_to_org-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "39a596d071679a7c0c651d92a509852e",
"sha256": "0f11997c295a05f7fedf9937cbd24e928c5f3cf121abbf2dce425d5206c38248"
},
"downloads": -1,
"filename": "vimwiki_to_org-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "39a596d071679a7c0c651d92a509852e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 22892,
"upload_time": "2022-12-08T13:48:10",
"upload_time_iso_8601": "2022-12-08T13:48:10.719821Z",
"url": "https://files.pythonhosted.org/packages/1e/cd/3ba5fdb6be8658afc798d78bb14567eca4574f876489c6a77face05260da/vimwiki_to_org-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-08 13:48:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "CryptoRodeo",
"github_project": "VimWikiToOrg",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pytest",
"specs": []
}
],
"tox": true,
"lcname": "vimwiki-to-org"
}
JSON
