{"id":16983994,"url":"https://github.com/ratfactor/vviki","last_synced_at":"2026-02-28T09:30:15.588Z","repository":{"id":56468702,"uuid":"237864617","full_name":"ratfactor/vviki","owner":"ratfactor","description":"AsciiDoc-flavored wiki plugin for Vim","archived":true,"fork":false,"pushed_at":"2023-09-27T22:58:48.000Z","size":44,"stargazers_count":26,"open_issues_count":1,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-12T09:12:18.269Z","etag":null,"topics":[],"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/ratfactor.png","metadata":{"files":{"readme":"README.adoc","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}},"created_at":"2020-02-03T01:35:38.000Z","updated_at":"2025-01-24T13:26:42.000Z","dependencies_parsed_at":"2022-08-15T19:20:30.416Z","dependency_job_id":null,"html_url":"https://github.com/ratfactor/vviki","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/ratfactor%2Fvviki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ratfactor%2Fvviki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ratfactor%2Fvviki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ratfactor%2Fvviki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ratfactor","download_url":"https://codeload.github.com/ratfactor/vviki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239872614,"owners_count":19711098,"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":[],"created_at":"2024-10-14T02:29:50.150Z","updated_at":"2026-02-28T09:30:15.526Z","avatar_url":"https://github.com/ratfactor.png","language":"Vim Script","readme":"= VViki\n\n\n**MOVED!** Hello, I am moving my repos to http://ratfactor.com/repos/\nand setting them to read-only (\"archived\") on GitHub. Thank you, _-Dave_\n\nimage::vviki.svg[VViki Logo,align=center]\n\n== Overview\n\nVViki is a tiny AsciiDoc-flavored wiki plugin for Vim.\nIt was inspired by link:https://github.com/vimwiki/vimwiki[VimWiki], \nuses Vim's existing AsciiDoc syntax highlighting,\nand aims to be extremely lightweight.\n\n== Features / Usage\n\n* Hit Enter on a word to create a link\n* Hit Enter on a link to edit that page (or open URL in a browser)\n* Backspace opens previous page\n* Tab jumps the cursor to the next link on the page\n\n\n== Install\n\nVViki is in the standard Vim plugin structure. Any plugin installation method (incuding popular plugin managers) should work. If you have additional installation instructions to add here, I'll gladly add them:\n\n=== Vundle\n\nAdd this to your plugin list (in your `.vimrc` file):\n\n----\nPlugin 'ratfactor/vviki'\n----\n\nThen run `:source %` and `:BundleInstall`.\n\n== Setup\n\nAdd something like this to your `~/.vimrc` file (or equivalent):\n\n----\n\" VViki setup - relies on the default wiki root dir (~/wiki)\nnnoremap \u003cleader\u003eww :e ~/wiki/index.adoc\u003ccr\u003e\n----\n\nThe above mapping will open a page called `index` when you type '\u003cleader\u003eww'. (Vim's default leader key is '\\'. If you've not changed it, you'd type type '\\ww'.)  Users coming from VimWiki will be familiar with this mapping.\n\nNote: VViki does not currently create directories, so you'll need to create `~/wiki` if it does not already exist.\n\n== Advanced Setup\n\nBy default, VViki uses `~/wiki` as the wiki \"root\" directory and looks for pages having an `.adoc` extension.  Any file under this directory (or subdirectory) ending in .adoc will be detected as a wiki page.\n\nHere's a setup example which changes the root directory and extension:\n\n----\n\" VViki setup\nlet g:vviki_root = \"~/secret_diary\"\nlet g:vviki_ext  = \".txt\"\nnnoremap \u003cleader\u003eww :e ~/secret_diary/index.txt\u003ccr\u003e\n----\n\nSee `:help vviki` for complete documentation and specifically `:help vviki-configuration` for all settings.\n\n== Why?\n\nI love link:https://github.com/vimwiki/vimwiki[VimWiki].\nI also love AsciiDoc, but VimWiki doesn't support AsciiDoc syntax.\nI put a day or two into adding full AsciiDoc support to VimWiki, but eventually concluded, \"it would be faster just to create my own plugin.\"  And it was!\n\nVViki aims to \"do one thing and do it well\".\nThis table explains the difference:\n\n[options=\"header\"]\n|===\n|Feature|VimWiki|VViki\n|Wiki functionality|X|X\n|Syntax highlighting|X|\n|Tooling (search, HTML export, etc.)|X|\n|===\n\n\n== Testing\n\nRunning the interactive test script is an easy way to try out VViki's basic functionality without setting up or installing anything. VViki does not even need to be installed as a plugin!\n\nTo go from nothing to trying out and testing a wiki, try this:\n\n----\ngit clone https://github.com/ratfactor/vviki\ncd vviki\nvim -S test/test.vim\n----\n\nThe first test document should open immediately. It contains instructions for using the tests (shortcut keys are mapped for fast/easy usage). All tests are self-documented.\n\n\n== TODO\n\n* [x] Absolute vs relative internal links\n* [x] Make VViki a \"real\" plugin\n* [x] Fix bug with description in link macros - need proper line parsing\n* [x] Try using 'conceal' for syntax to display pretty links\n* [x] Configurable wiki path\n* [x] Configurable wiki file extension\n* [x] Add default \"index\" files for \"directory/\" wiki paths\n* [x] Start help doc\n* [x] Finish help doc\n* [x] Global setting to turn off link syntax conceal\n* [x] Add \u003ctab\u003e key link navigation (jump to next link)\n* [x] Release 1.0\n* [ ] Wishlist: Consider creating directories as needed (limit to wiki root)\n* [ ] Wishlist: some sort of shortcut (with pattern matching) to add\n      links to existing wiki pages\n* [ ] Wishlist: checklist shortcuts (check/uncheck [ ] boxes)\n\n\n== License\n\nMIT License\n\nCopyright (c) 2020 Dave Gauer\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fratfactor%2Fvviki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fratfactor%2Fvviki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fratfactor%2Fvviki/lists"}