{"id":16836358,"url":"https://github.com/mvertes/vimki","last_synced_at":"2025-03-18T03:18:58.964Z","repository":{"id":75669725,"uuid":"262531832","full_name":"mvertes/vimki","owner":"mvertes","description":"vimki turns vim into a text wiki","archived":false,"fork":false,"pushed_at":"2022-05-13T10:27:07.000Z","size":26,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-24T10:23:55.510Z","etag":null,"topics":["personal-wiki","vim","vim-plugin","viml","wiki"],"latest_commit_sha":null,"homepage":"","language":"Vim script","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/mvertes.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":"2020-05-09T09:07:03.000Z","updated_at":"2022-05-13T10:27:11.000Z","dependencies_parsed_at":"2023-06-07T07:45:11.503Z","dependency_job_id":null,"html_url":"https://github.com/mvertes/vimki","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mvertes%2Fvimki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mvertes%2Fvimki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mvertes%2Fvimki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mvertes%2Fvimki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mvertes","download_url":"https://codeload.github.com/mvertes/vimki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244147343,"owners_count":20405942,"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":["personal-wiki","vim","vim-plugin","viml","wiki"],"created_at":"2024-10-13T12:13:12.558Z","updated_at":"2025-03-18T03:18:58.942Z","avatar_url":"https://github.com/mvertes.png","language":"Vim script","funding_links":[],"categories":[],"sub_categories":[],"readme":"vim :heart: wiki = vimki\n========================\n\nIf you use Vim and like to keep notes as text files, then you should\nlike this simple plugin.\n\nVimki allows to browse, navigate and edit a collection of text files in\na single directory (usually `~/Wiki`). These files contain hyperlinks to\neach other in the form of [WikiWords], as in the original [WikiWikiWeb].\n\nSo it smells like 1995 ? That's the goal :-). Text files are here to\nstay, cost almost nothing to store, and will still be available in the\nsame form in the next decades and beyond. A dead simple wiki in plain\nold text is both durable and scalable.\n\nI can (and do) throw everything at it: some random notes, my diary\n(a file per month), my contacts, my research notes and references, a\ncatalog of all my stuff, books, films, music with the links to open when\navailable, etc. All kind of data, loosely coupled or well structured,\npersonal or professional, public or private (using `:X` vim command), but\nalways interlinked. And as for the brain, with a growing number of\nlinks with the time.\n\nThe point of using vimki is to remove any friction in the flow of\nbrowsing, reading and writing. Everything you read is writable right now.\nTo open a new file, I write a WikiWord, press `Return` with the cursor\non it, and I'm now editing it (or just press `,,` to go back, as I set\n`,` as vim `\u003cLeader\u003e` key on my french keyboard). And all collisions\n(content already existing for a new WikiWord) are in fact happy accidents\nwith deep meaning.\n\nThe purpose of vimki is only to bring a wiki capability (quickly create\nand navigate in interconnected text files) to the editor, in the simplest\nand most straightforward manner. The goal is not to address document\nformatting, content generation or other features which can be better\naddressed by apropriate offline tools.\n\nInstallation\n------------\n\nVimki should install with your favorite package manager.  For example,\nusing [vim-plug], add `Plug 'mvertes/vimki'` in the vim-plug section of\nyour `~/.vimrc` and in vim, run `:PlugInstall`.\n\nUsage\n-----\n\nThe default mappings, present from any buffer, are defined as follow\n(by default, `\u003cLeader\u003e` stands for `\\`):\n\n| mapping      | action                 |\n| ------------ | ---------------------- |\n| `\u003cLeader\u003eww` | open the Wiki HomePage |\n| `\u003cLeader\u003ewi` | open the Wiki index    |\n| `\u003cLeader\u003ewf` | follow a WikiWord      |\n\nThe following mappings are present when editing a Wiki file:\n\n| mapping             | action                               |\n| ------------------- | ------------------------------------ |\n|  `\u003cLeader\u003e\u003cLeader\u003e` | close the file (back to previous)    |\n|  `\u003cCR\u003e`             | follow the WikiWord under the cursor |\n|  `\u003cTab\u003e`            | move to the next WikiWord            |\n|  `\u003cBS\u003e`             | move to the previous WikiWord        |\n|  `\u003cLeader\u003ewr`       | reload WikiWords                     |\n\nCustomization\n-------------\n\nSeveral variables are checked by the script to customize vimki\nbehavior. You can set them using let in your `vimrc` file.\nExample:\n```vim\n        let vimki_home = \"$HOME/MyWiki/HomePage\"\n```\n| variable          | default  | description                               |\n| ----------------- | ----     | ----------------------------------------- |\n| `vimki_suffix`    | `\"\"`     | suffix appended to the names of WikiFiles |\n| `vimki_home`      | `$HOME/Wiki/HomePage + wimki_suffix` | path of Wiki HomePage |\n| `vimki_home_dir`  | dir of `vimki_home` |  path of Wiki directory |\n| `vimki_upper`     | `'A-Z'`  | upper case characters for WikiWords |\n| `vimki_lower`     | `'a-z'`  | lower case characters for WikiWords |\n| `vimki_other`     | `'0-9_'` | non-letter characters for WikiWords |\n| `vimki_autowrite` | `1`      | to automatically write a Wiki file on close |\n| `vimki_ignore`    | `\"\"`     | comma-separated list of words to ignore |\n\nBugs\n----\n\nIssues and pull-requests are opened at https://github.com/mvertes/vimki.\n\nCredits\n-------\n\nThis plugin was inspired by [potwiki], [vimwiki] and some other projects.\n\n[vim-plug]: https://github.com/junegunn/vim-plug\n[WikiWords]: https://wiki.c2.com/?WikiWord\n[WikiWikiWeb]: https://en.wikipedia.org/wiki/WikiWikiWeb\n[potwiki]: https://www.vim.org/scripts/script.php?script_id=1018\n[vimwiki]: https://github.com/vimwiki/vimwiki\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmvertes%2Fvimki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmvertes%2Fvimki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmvertes%2Fvimki/lists"}