{"id":13682817,"url":"https://github.com/sstallion/vimwiki-skel","last_synced_at":"2025-10-30T16:03:14.351Z","repository":{"id":80978384,"uuid":"138784619","full_name":"sstallion/vimwiki-skel","owner":"sstallion","description":"Skeleton for seeding new Vimwiki instances","archived":false,"fork":false,"pushed_at":"2022-05-07T00:48:58.000Z","size":12,"stargazers_count":21,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-02T13:34:35.049Z","etag":null,"topics":["mdwiki","skeleton","vim","vimwiki","wiki"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/sstallion.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-06-26T19:38:13.000Z","updated_at":"2024-03-18T03:33:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"f2c8c1cb-0fad-4233-b88d-1192096ebd68","html_url":"https://github.com/sstallion/vimwiki-skel","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sstallion%2Fvimwiki-skel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sstallion%2Fvimwiki-skel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sstallion%2Fvimwiki-skel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sstallion%2Fvimwiki-skel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sstallion","download_url":"https://codeload.github.com/sstallion/vimwiki-skel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223460621,"owners_count":17148760,"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":["mdwiki","skeleton","vim","vimwiki","wiki"],"created_at":"2024-08-02T13:01:53.805Z","updated_at":"2025-10-30T16:03:14.285Z","avatar_url":"https://github.com/sstallion.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# Vimwiki\n\n![](images/vimlogo-small.png) This repository contains a [Vimwiki][1] instance\nusing [Markdown][2] syntax backed by Git. HTML rendering is provided by\n[MDwiki][3]; content may be viewed online using a traditional web server or\noffline using a script (see [below](#Offline_Viewing)).\n\n## Installation\n\nTo initialize a new wiki instance, a clone of this repository can be made to\nsimplify setup:\n\n    $ git clone git://github.com/sstallion/vimwiki-skel.git vimwiki \u0026\u0026 cd vimwiki\n    $ git remote set-url origin \u003crepository\u003e\n    $ git push -u origin master\n\nOnce initialized, `install.sh` should be called to install MDwiki and create the\nappropriate symlink under `$HOME`:\n\n    $ sh install.sh [instance]\n\nFinally, [Vimwiki][1] should be installed if it is not already.\n\n## Configuration\n\nAt a minimum, the `vimwiki` plugin must be configured with the wiki instance\nlocation by adding the following to your `.vimrc`:\n\n    let g:vimwiki_list = [{'path': '~/.vimwiki', 'syntax': 'markdown', 'ext': '.md'}]\n\nIf multiple instances are installed, they must be added to this list as well:\n\n    let g:vimwiki_list = [{'path': '~/.vimwiki-home', 'syntax': 'markdown', 'ext': '.md'}]\n                       \\  {'path': '~/.vimwiki-work', 'syntax': 'markdown', 'ext': '.md'}]\n\nIt is advised to disable global extension support to avoid having all Markdown\nfiles treated as if they were part of the wiki by adding the following to your\n`.vimrc`:\n\n    let g:vimwiki_global_ext = 0\n\nFor more detail, see: `:help g:vimwiki_global_ext`.\n\n## Compatibility\n\nBy default, Vimwiki does not add a file extension to generated wiki links, which\nis incompatible with MDwiki. PR [#529] addresses this issue by adding a new\noption `g:vimwiki_markdown_link_ext` to include the file extension. To correct\nthis issue, add the following to your `.vimrc`:\n\n    let g:vimwiki_markdown_link_ext = 1\n\n[#529]: https://github.com/vimwiki/vimwiki/pull/529\n\n## External Wikis\n\nFrom time to time, it can be useful to reference wikis belonging to other\nrepositories. Fortunately, the `git-submodule(1)` mechanism can be used to\nreference these repositories from the wiki instance:\n\n    $ git submodule add \u003crepository\u003e external/\u003cname\u003e\n\nOnce added, simply reference the page by adding a link to your wiki:\n\n    [Link Text](external/\u003cname\u003e/\u003cpage\u003e.md)\n\n## Offline Viewing\n\nIf you wish to view the wiki offline using a browser, a simple HTTP server can\nbe started locally by calling `serve.sh` in the repository root (requires Python\n2.x):\n\n    $ sh serve.sh [port]\n    Serving HTTP on 0.0.0.0 port 8080 ...\n\nContent may then be viewed by visiting http://localhost:8080/ using your\nbrowser.\n\n## Contributing\n\nPull requests are welcome! If a problem is encountered using this repository,\nplease file an issue on [GitHub][4].\n\n[1]: https://vimwiki.github.io/\n[2]: https://daringfireball.net/projects/markdown/syntax\n[3]: https://dynalon.github.io/mdwiki/\n[4]: https://github.com/sstallion/vimwiki-skel/issues\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsstallion%2Fvimwiki-skel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsstallion%2Fvimwiki-skel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsstallion%2Fvimwiki-skel/lists"}