├── COPYING ├── README.md ├── docs ├── Related Tools.html ├── Tips and Snips.html ├── Troubleshooting.html ├── index.html ├── logos │ ├── logo-darker.svg │ ├── logo.svg │ ├── vertical-logo-darker.svg │ └── vertical-logo.svg └── style.css └── wiki ├── Related Tools.wiki ├── Tips and Snips.wiki ├── Troubleshooting.wiki └── index.wiki /COPYING: -------------------------------------------------------------------------------- 1 | This Wiki is dual-licensed unter MIT License and Creative Commons 2 | Attribution-ShareAlike 4.0 International, you can choose whichever license you 3 | want. 4 | 5 | 6 | MIT License 7 | 8 | Copyright (c) 2019 Michael F. Schönitzer 9 | 10 | Permission is hereby granted, free of charge, to any person obtaining a copy 11 | of this software and associated documentation files (the "Software"), to deal 12 | in the Software without restriction, including without limitation the rights 13 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 14 | copies of the Software, and to permit persons to whom the Software is 15 | furnished to do so, subject to the following conditions: 16 | 17 | The above copyright notice and this permission notice shall be included in all 18 | copies or substantial portions of the Software. 19 | 20 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 21 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 22 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 23 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 24 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 25 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 26 | SOFTWARE. 27 | 28 | 29 | Attribution-ShareAlike 4.0 International 30 | 31 | ======================================================================= 32 | 33 | Creative Commons Corporation ("Creative Commons") is not a law firm and 34 | does not provide legal services or legal advice. Distribution of 35 | Creative Commons public licenses does not create a lawyer-client or 36 | other relationship. Creative Commons makes its licenses and related 37 | information available on an "as-is" basis. Creative Commons gives no 38 | warranties regarding its licenses, any material licensed under their 39 | terms and conditions, or any related information. Creative Commons 40 | disclaims all liability for damages resulting from their use to the 41 | fullest extent possible. 42 | 43 | Using Creative Commons Public Licenses 44 | 45 | Creative Commons public licenses provide a standard set of terms and 46 | conditions that creators and other rights holders may use to share 47 | original works of authorship and other material subject to copyright 48 | and certain other rights specified in the public license below. The 49 | following considerations are for informational purposes only, are not 50 | exhaustive, and do not form part of our licenses. 51 | 52 | Considerations for licensors: Our public licenses are 53 | intended for use by those authorized to give the public 54 | permission to use material in ways otherwise restricted by 55 | copyright and certain other rights. Our licenses are 56 | irrevocable. Licensors should read and understand the terms 57 | and conditions of the license they choose before applying it. 58 | Licensors should also secure all rights necessary before 59 | applying our licenses so that the public can reuse the 60 | material as expected. Licensors should clearly mark any 61 | material not subject to the license. This includes other CC- 62 | licensed material, or material used under an exception or 63 | limitation to copyright. More considerations for licensors: 64 | wiki.creativecommons.org/Considerations_for_licensors 65 | 66 | Considerations for the public: By using one of our public 67 | licenses, a licensor grants the public permission to use the 68 | licensed material under specified terms and conditions. If 69 | the licensor's permission is not necessary for any reason--for 70 | example, because of any applicable exception or limitation to 71 | copyright--then that use is not regulated by the license. Our 72 | licenses grant only permissions under copyright and certain 73 | other rights that a licensor has authority to grant. Use of 74 | the licensed material may still be restricted for other 75 | reasons, including because others have copyright or other 76 | rights in the material. A licensor may make special requests, 77 | such as asking that all changes be marked or described. 78 | Although not required by our licenses, you are encouraged to 79 | respect those requests where reasonable. More_considerations 80 | for the public: 81 | wiki.creativecommons.org/Considerations_for_licensees 82 | 83 | ======================================================================= 84 | 85 | Creative Commons Attribution-ShareAlike 4.0 International Public 86 | License 87 | 88 | By exercising the Licensed Rights (defined below), You accept and agree 89 | to be bound by the terms and conditions of this Creative Commons 90 | Attribution-ShareAlike 4.0 International Public License ("Public 91 | License"). To the extent this Public License may be interpreted as a 92 | contract, You are granted the Licensed Rights in consideration of Your 93 | acceptance of these terms and conditions, and the Licensor grants You 94 | such rights in consideration of benefits the Licensor receives from 95 | making the Licensed Material available under these terms and 96 | conditions. 97 | 98 | 99 | Section 1 -- Definitions. 100 | 101 | a. Adapted Material means material subject to Copyright and Similar 102 | Rights that is derived from or based upon the Licensed Material 103 | and in which the Licensed Material is translated, altered, 104 | arranged, transformed, or otherwise modified in a manner requiring 105 | permission under the Copyright and Similar Rights held by the 106 | Licensor. For purposes of this Public License, where the Licensed 107 | Material is a musical work, performance, or sound recording, 108 | Adapted Material is always produced where the Licensed Material is 109 | synched in timed relation with a moving image. 110 | 111 | b. Adapter's License means the license You apply to Your Copyright 112 | and Similar Rights in Your contributions to Adapted Material in 113 | accordance with the terms and conditions of this Public License. 114 | 115 | c. BY-SA Compatible License means a license listed at 116 | creativecommons.org/compatiblelicenses, approved by Creative 117 | Commons as essentially the equivalent of this Public License. 118 | 119 | d. Copyright and Similar Rights means copyright and/or similar rights 120 | closely related to copyright including, without limitation, 121 | performance, broadcast, sound recording, and Sui Generis Database 122 | Rights, without regard to how the rights are labeled or 123 | categorized. For purposes of this Public License, the rights 124 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 125 | Rights. 126 | 127 | e. Effective Technological Measures means those measures that, in the 128 | absence of proper authority, may not be circumvented under laws 129 | fulfilling obligations under Article 11 of the WIPO Copyright 130 | Treaty adopted on December 20, 1996, and/or similar international 131 | agreements. 132 | 133 | f. Exceptions and Limitations means fair use, fair dealing, and/or 134 | any other exception or limitation to Copyright and Similar Rights 135 | that applies to Your use of the Licensed Material. 136 | 137 | g. License Elements means the license attributes listed in the name 138 | of a Creative Commons Public License. The License Elements of this 139 | Public License are Attribution and ShareAlike. 140 | 141 | h. Licensed Material means the artistic or literary work, database, 142 | or other material to which the Licensor applied this Public 143 | License. 144 | 145 | i. Licensed Rights means the rights granted to You subject to the 146 | terms and conditions of this Public License, which are limited to 147 | all Copyright and Similar Rights that apply to Your use of the 148 | Licensed Material and that the Licensor has authority to license. 149 | 150 | j. Licensor means the individual(s) or entity(ies) granting rights 151 | under this Public License. 152 | 153 | k. Share means to provide material to the public by any means or 154 | process that requires permission under the Licensed Rights, such 155 | as reproduction, public display, public performance, distribution, 156 | dissemination, communication, or importation, and to make material 157 | available to the public including in ways that members of the 158 | public may access the material from a place and at a time 159 | individually chosen by them. 160 | 161 | l. Sui Generis Database Rights means rights other than copyright 162 | resulting from Directive 96/9/EC of the European Parliament and of 163 | the Council of 11 March 1996 on the legal protection of databases, 164 | as amended and/or succeeded, as well as other essentially 165 | equivalent rights anywhere in the world. 166 | 167 | m. You means the individual or entity exercising the Licensed Rights 168 | under this Public License. Your has a corresponding meaning. 169 | 170 | 171 | Section 2 -- Scope. 172 | 173 | a. License grant. 174 | 175 | 1. Subject to the terms and conditions of this Public License, 176 | the Licensor hereby grants You a worldwide, royalty-free, 177 | non-sublicensable, non-exclusive, irrevocable license to 178 | exercise the Licensed Rights in the Licensed Material to: 179 | 180 | a. reproduce and Share the Licensed Material, in whole or 181 | in part; and 182 | 183 | b. produce, reproduce, and Share Adapted Material. 184 | 185 | 2. Exceptions and Limitations. For the avoidance of doubt, where 186 | Exceptions and Limitations apply to Your use, this Public 187 | License does not apply, and You do not need to comply with 188 | its terms and conditions. 189 | 190 | 3. Term. The term of this Public License is specified in Section 191 | 6(a). 192 | 193 | 4. Media and formats; technical modifications allowed. The 194 | Licensor authorizes You to exercise the Licensed Rights in 195 | all media and formats whether now known or hereafter created, 196 | and to make technical modifications necessary to do so. The 197 | Licensor waives and/or agrees not to assert any right or 198 | authority to forbid You from making technical modifications 199 | necessary to exercise the Licensed Rights, including 200 | technical modifications necessary to circumvent Effective 201 | Technological Measures. For purposes of this Public License, 202 | simply making modifications authorized by this Section 2(a) 203 | (4) never produces Adapted Material. 204 | 205 | 5. Downstream recipients. 206 | 207 | a. Offer from the Licensor -- Licensed Material. Every 208 | recipient of the Licensed Material automatically 209 | receives an offer from the Licensor to exercise the 210 | Licensed Rights under the terms and conditions of this 211 | Public License. 212 | 213 | b. Additional offer from the Licensor -- Adapted Material. 214 | Every recipient of Adapted Material from You 215 | automatically receives an offer from the Licensor to 216 | exercise the Licensed Rights in the Adapted Material 217 | under the conditions of the Adapter's License You apply. 218 | 219 | c. No downstream restrictions. You may not offer or impose 220 | any additional or different terms or conditions on, or 221 | apply any Effective Technological Measures to, the 222 | Licensed Material if doing so restricts exercise of the 223 | Licensed Rights by any recipient of the Licensed 224 | Material. 225 | 226 | 6. No endorsement. Nothing in this Public License constitutes or 227 | may be construed as permission to assert or imply that You 228 | are, or that Your use of the Licensed Material is, connected 229 | with, or sponsored, endorsed, or granted official status by, 230 | the Licensor or others designated to receive attribution as 231 | provided in Section 3(a)(1)(A)(i). 232 | 233 | b. Other rights. 234 | 235 | 1. Moral rights, such as the right of integrity, are not 236 | licensed under this Public License, nor are publicity, 237 | privacy, and/or other similar personality rights; however, to 238 | the extent possible, the Licensor waives and/or agrees not to 239 | assert any such rights held by the Licensor to the limited 240 | extent necessary to allow You to exercise the Licensed 241 | Rights, but not otherwise. 242 | 243 | 2. Patent and trademark rights are not licensed under this 244 | Public License. 245 | 246 | 3. To the extent possible, the Licensor waives any right to 247 | collect royalties from You for the exercise of the Licensed 248 | Rights, whether directly or through a collecting society 249 | under any voluntary or waivable statutory or compulsory 250 | licensing scheme. In all other cases the Licensor expressly 251 | reserves any right to collect such royalties. 252 | 253 | 254 | Section 3 -- License Conditions. 255 | 256 | Your exercise of the Licensed Rights is expressly made subject to the 257 | following conditions. 258 | 259 | a. Attribution. 260 | 261 | 1. If You Share the Licensed Material (including in modified 262 | form), You must: 263 | 264 | a. retain the following if it is supplied by the Licensor 265 | with the Licensed Material: 266 | 267 | i. identification of the creator(s) of the Licensed 268 | Material and any others designated to receive 269 | attribution, in any reasonable manner requested by 270 | the Licensor (including by pseudonym if 271 | designated); 272 | 273 | ii. a copyright notice; 274 | 275 | iii. a notice that refers to this Public License; 276 | 277 | iv. a notice that refers to the disclaimer of 278 | warranties; 279 | 280 | v. a URI or hyperlink to the Licensed Material to the 281 | extent reasonably practicable; 282 | 283 | b. indicate if You modified the Licensed Material and 284 | retain an indication of any previous modifications; and 285 | 286 | c. indicate the Licensed Material is licensed under this 287 | Public License, and include the text of, or the URI or 288 | hyperlink to, this Public License. 289 | 290 | 2. You may satisfy the conditions in Section 3(a)(1) in any 291 | reasonable manner based on the medium, means, and context in 292 | which You Share the Licensed Material. For example, it may be 293 | reasonable to satisfy the conditions by providing a URI or 294 | hyperlink to a resource that includes the required 295 | information. 296 | 297 | 3. If requested by the Licensor, You must remove any of the 298 | information required by Section 3(a)(1)(A) to the extent 299 | reasonably practicable. 300 | 301 | b. ShareAlike. 302 | 303 | In addition to the conditions in Section 3(a), if You Share 304 | Adapted Material You produce, the following conditions also apply. 305 | 306 | 1. The Adapter's License You apply must be a Creative Commons 307 | license with the same License Elements, this version or 308 | later, or a BY-SA Compatible License. 309 | 310 | 2. You must include the text of, or the URI or hyperlink to, the 311 | Adapter's License You apply. You may satisfy this condition 312 | in any reasonable manner based on the medium, means, and 313 | context in which You Share Adapted Material. 314 | 315 | 3. You may not offer or impose any additional or different terms 316 | or conditions on, or apply any Effective Technological 317 | Measures to, Adapted Material that restrict exercise of the 318 | rights granted under the Adapter's License You apply. 319 | 320 | 321 | Section 4 -- Sui Generis Database Rights. 322 | 323 | Where the Licensed Rights include Sui Generis Database Rights that 324 | apply to Your use of the Licensed Material: 325 | 326 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 327 | to extract, reuse, reproduce, and Share all or a substantial 328 | portion of the contents of the database; 329 | 330 | b. if You include all or a substantial portion of the database 331 | contents in a database in which You have Sui Generis Database 332 | Rights, then the database in which You have Sui Generis Database 333 | Rights (but not its individual contents) is Adapted Material, 334 | 335 | including for purposes of Section 3(b); and 336 | c. You must comply with the conditions in Section 3(a) if You Share 337 | all or a substantial portion of the contents of the database. 338 | 339 | For the avoidance of doubt, this Section 4 supplements and does not 340 | replace Your obligations under this Public License where the Licensed 341 | Rights include other Copyright and Similar Rights. 342 | 343 | 344 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 345 | 346 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 347 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 348 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 349 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 350 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 351 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 352 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 353 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 354 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 355 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 356 | 357 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 358 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 359 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 360 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 361 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 362 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 363 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 364 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 365 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 366 | 367 | c. The disclaimer of warranties and limitation of liability provided 368 | above shall be interpreted in a manner that, to the extent 369 | possible, most closely approximates an absolute disclaimer and 370 | waiver of all liability. 371 | 372 | 373 | Section 6 -- Term and Termination. 374 | 375 | a. This Public License applies for the term of the Copyright and 376 | Similar Rights licensed here. However, if You fail to comply with 377 | this Public License, then Your rights under this Public License 378 | terminate automatically. 379 | 380 | b. Where Your right to use the Licensed Material has terminated under 381 | Section 6(a), it reinstates: 382 | 383 | 1. automatically as of the date the violation is cured, provided 384 | it is cured within 30 days of Your discovery of the 385 | violation; or 386 | 387 | 2. upon express reinstatement by the Licensor. 388 | 389 | For the avoidance of doubt, this Section 6(b) does not affect any 390 | right the Licensor may have to seek remedies for Your violations 391 | of this Public License. 392 | 393 | c. For the avoidance of doubt, the Licensor may also offer the 394 | Licensed Material under separate terms or conditions or stop 395 | distributing the Licensed Material at any time; however, doing so 396 | will not terminate this Public License. 397 | 398 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 399 | License. 400 | 401 | 402 | Section 7 -- Other Terms and Conditions. 403 | 404 | a. The Licensor shall not be bound by any additional or different 405 | terms or conditions communicated by You unless expressly agreed. 406 | 407 | b. Any arrangements, understandings, or agreements regarding the 408 | Licensed Material not stated herein are separate from and 409 | independent of the terms and conditions of this Public License. 410 | 411 | 412 | Section 8 -- Interpretation. 413 | 414 | a. For the avoidance of doubt, this Public License does not, and 415 | shall not be interpreted to, reduce, limit, restrict, or impose 416 | conditions on any use of the Licensed Material that could lawfully 417 | be made without permission under this Public License. 418 | 419 | b. To the extent possible, if any provision of this Public License is 420 | deemed unenforceable, it shall be automatically reformed to the 421 | minimum extent necessary to make it enforceable. If the provision 422 | cannot be reformed, it shall be severed from this Public License 423 | without affecting the enforceability of the remaining terms and 424 | conditions. 425 | 426 | c. No term or condition of this Public License will be waived and no 427 | failure to comply consented to unless expressly agreed to by the 428 | Licensor. 429 | 430 | d. Nothing in this Public License constitutes or may be interpreted 431 | as a limitation upon, or waiver of, any privileges and immunities 432 | that apply to the Licensor or You, including from the legal 433 | processes of any jurisdiction or authority. 434 | 435 | 436 | ======================================================================= 437 | 438 | Creative Commons is not a party to its public 439 | licenses. Notwithstanding, Creative Commons may elect to apply one of 440 | its public licenses to material it publishes and in those instances 441 | will be considered the “Licensor.” The text of the Creative Commons 442 | public licenses is dedicated to the public domain under the CC0 Public 443 | Domain Dedication. Except for the limited purpose of indicating that 444 | material is shared under a Creative Commons public license or as 445 | otherwise permitted by the Creative Commons policies published at 446 | creativecommons.org/policies, Creative Commons does not authorize the 447 | use of the trademark "Creative Commons" or any other trademark or logo 448 | of Creative Commons without its prior written consent including, 449 | without limitation, in connection with any unauthorized modifications 450 | to any of its public licenses or any other arrangements, 451 | understandings, or agreements concerning use of licensed material. For 452 | the avoidance of doubt, this paragraph does not form part of the 453 | public licenses. 454 | 455 | Creative Commons may be contacted at creativecommons.org. 456 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # VimwikiWiki 2 | 3 | A [Vimwiki Wiki](https://vimwiki.github.io/vimwikiwiki) about Vimwiki. 4 | 5 | - `doc/` folder contains generated html served by GitHub pages. 6 | - `wiki/` folder contains the Vimwiki Wiki (default syntax) source files. 7 | 8 | To use configure it as an additional wiki in your vimrc: 9 | 10 | ``` 11 | let g:vimwiki_list = [ 12 | \ { 13 | 14 | \ }, 15 | \ { 16 | \ 'path': '/wiki', 17 | \ 'path_html': '/docs', 18 | \ 'auto_toc': 1}, 19 | \ ] 20 | ``` 21 | 22 | To generate the HTML output run `:Vimwiki2HTML`. For PR commit both the 23 | wikitext and the rendered HTML. 24 | -------------------------------------------------------------------------------- /docs/Related Tools.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Related Tools 7 | 8 | 9 | 10 | 11 | 12 |

13 |

14 | 15 |

16 |

17 | This page contains Vim plugins and external tools that can be used with Vimwiki. 18 |

19 |

20 | These lists are incomplete so please help update them if you know of something 21 |

22 |

23 | that is missing! 24 |

25 |

26 | 27 |

28 |

29 |

30 | 31 |

32 |
    33 |
  • 34 | calendar-vim 35 |
    • 36 |
      37 |
    • 38 | Select a date to open a diary page. 39 |
      • 40 |
    41 |
  • 42 | link.vim 43 | 44 |
      45 |
    • 46 | Keep long URLs out of your way in Vimwiki (Markdown syntax). 47 | 48 |
    49 |
  • 50 | taskwiki 51 |
    • 52 |
      53 |
    • 54 | Integration with taskwarrior for task 55 | management. This only supports the default syntax. 56 |
      • 57 |
    58 |
  • 59 | Tagbar 60 |
    • 61 |
      62 |
    • 63 | Creates a sidebar to view generated tags. For Vimwiki this can be 64 | used to display links to headers. 65 |
      • 66 |
    • 67 | For this to work an additional script 68 | is needed which is available in the utility repository. 69 | Additional instructions are in the comments of the script. 70 |
      • 71 |
    • 72 | If using Markdown syntax # symbols used within code blocks are 73 | recognized as a header i.e. in a shell script snippet. An alternative 74 | version that works for Markdown can be found 75 | here. 76 |
      • 77 |
    78 |
  • 79 | vimwiki-tasks 80 |
    • 81 |
      82 |
    • 83 | Another integration with taskwarrior. This 84 | plugin does not seem to be maintained any longer. 85 |
      • 86 |
    87 |
  • 88 | vim-tagquery 89 |
    • 90 |
      91 |
    • 92 | A vim plugin that enables improved querying of tags. 93 |
      • 94 |
    • 95 | This can be used to search for multiple tags. 96 |
      • 97 |
    • 98 | See Issue #723 99 |
      • 100 |
    101 |
  • 102 | vim-medieval 103 |
    • 104 |
      105 |
    • 106 | Evaluate Markdown code blocks within Vim to scrathpad, or inline code block within the file 107 |
      • 108 |
    • 109 | Works for vimwiki syntax, see configuration wiki page 110 |
      • 111 |
    • 112 | Can be used for literate programming 113 |
      • 114 |
    115 |
  • 116 | vim-table-mode 117 |
    • 118 |
      119 |
    • 120 | Add formulas to Markdown tables 121 |
      • 122 |
    • 123 | Works for vimwiki syntax, see configuration gist example 124 |
      • 125 |
    126 |
127 |

128 |

129 | 130 |

131 |
    132 |
  • 133 | customwiki2html.sh 134 |
    • 135 |
      136 |
    • 137 | Script available in the official repository to convert Markdown to HTML. 138 |
      • 139 |
    • 140 | See the comments for more information and usage instructions. 141 |
      • 142 |
    143 |
  • 144 | Pandoc 145 |
    • 146 |
      147 |
    • 148 | Convert Vimwiki to various other formats such as HTML, PDF, etc. 149 |
      • 150 |
    151 |
  • 152 | vimwiki_markdown 153 |
    • 154 |
      155 |
    • 156 | A Ruby gem to convert vimwiki Markdown files to HTML. Still being actively 157 | developed. 158 |
      • 159 |
    160 |
  • 161 | vimwiki_markdown Python 162 |
    • 163 |
      164 |
    • 165 | A Python script to convert Markdown files to HTML. 166 |
      • 167 |
    • 168 | Also see Issue #578 169 |
      • 170 |
    171 |
  • 172 | vimwiki-godown 173 |
    • 174 |
      175 |
    • 176 | HTML converter that adds the ability to prefix relative links to other 177 | Vimwiki pages 178 |
      • 179 |
    • 180 | See Issue #284 181 |
      • 182 |
    183 |
  • 184 | vimwiki-skel 185 |
    • 186 |
      187 |
    • 188 | Uses MDWiki to convert 189 | Markdown files to HTML. 190 |
      • 191 |
    192 |
  • 193 | wiki2html.sh Gist 194 |
    • 195 |
      196 |
    • 197 | Uses Pandoc to convert Markdown files to HTML. 198 |
      • 199 |
    200 |
  • 201 | vimwiki2org 202 |
    • 203 |
      204 |
    • 205 | Convert vimwiki to Emacs orgmode. Has not been 206 | updated in 6 years. 207 |
      • 208 |
    209 |
  • 210 | vwweb 211 |
    • 212 |
      213 |
    • 214 | Python script to generate a website from Vimwiki files. 215 |
      • 216 |
    217 |
  • 218 | vimwiki-todo-jabberbot 219 |
    • 220 |
      221 |
    • 222 | Todo management using Jabberbot. The linked GitHub repository seems to 223 | have been removed. 224 |
      • 225 |
    226 |
  • 227 | vimwiki-tools 228 |
    • 229 |
      230 |
    • 231 | Python tool to generate an index and convert wiki files to Markdown 232 | format. This has not been updated in 6 years. 233 |
      • 234 |
    235 |
  • 236 | vimwiki-cli 237 |
    • 238 |
      239 |
    • 240 | Python CLI that provides a front-end for interactive editor commands and 241 | can be used to automate repetitive tasks such as rebuilding tag metadata 242 | and generating links, all from the command line. 243 |
      • 244 |
    245 |
246 | 247 | 248 | 249 | -------------------------------------------------------------------------------- /docs/Tips and Snips.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Tips and Snips 7 | 8 | 9 | 10 | 11 | 12 |

13 |

14 | 15 |

16 |

17 | Vimwiki cannot be all things to all users so here are some tips and code 18 |

19 |

20 | snippets you may find useful for customizing Vimwiki to your liking. 21 |

22 |

23 | 24 |

25 |

26 |

27 | There are several cheat sheets for Vimwiki: 28 |

29 | 40 |

41 |

42 | 43 |

44 |

45 | Vimwiki has simple folding folding methods built in but lets you easily 46 |

47 |

48 | customize folds with the g:vimwiki_folding option. For example, if you prefer 49 |

50 |

51 | that the last blank line before a heading not get folded, add this to your 52 |

53 |

54 | .vimrc file: 55 |

56 |

57 | 58 |

59 |

60 | let g:vimwiki_folding = 'custom' 61 |

62 |

63 | 64 |

65 |

66 | Then add the following to the ftplugin/vimwiki.vim plugin in your .vim 67 |

68 |

69 | configuration folder (create this file if it doesn't already exist): 70 |

71 |

72 | 73 |

74 | 
 75 | let l:vimwiki_fold_blank_lines = 0  " set to 1 to fold blank lines
 76 | let l:vimwiki_header_type = '#'     " set to '=' for wiki syntax
 77 | setlocal foldlevel=1
 78 | setlocal foldenable
 79 | setlocal foldmethod=expr
 80 | setlocal foldexpr=Fold(v:lnum)
 81 | 
 82 |  function! Fold(lnum)
 83 |    let fold_level = strlen(matchstr(getline(a:lnum), '^' . l:vimwiki_header_type . '\+'))
 84 |    if (fold_level)
 85 |      return '>' . fold_level  " start a fold level
 86 |    endif
 87 |    if getline(a:lnum) =~? '\v^\s*$'
 88 |      if (strlen(matchstr(getline(a:lnum + 1), '^' . l:vimwiki_header_type . '\+')) > 0 && !g:vimwiki_fold_blank_lines)
 89 |        return '-1' " don't fold last blank line before header
 90 |      endif
 91 |    endif
 92 |    return '=' " return previous fold level
 93 |  endfunction
 94 |
95 |

96 | 97 |

98 |

99 |

100 | 101 |

102 |

103 | Vimwiki makes it effortless to add tasks to any wiki page. Unfortunately, 104 |

105 |

106 | this means that your tasks get dispersed rather widely, especially if 107 |

108 |

109 | you're tracking action items from meeting notes in your diary. The snippets 110 |

111 |

112 | below make it easier to manage tasks in vimwiki without adding any additional 113 |

114 |

115 | plugins or relying on external task management tools. 116 |

117 |

118 | 119 |

120 |

121 |

122 | 123 |

124 |

125 | The following will open a QuickFix window with incomplete tasks, but only those 126 |

127 |

128 | which are in a hyphenated (-) list. This is a simple way to filter only on 129 |

130 |

131 | tasks which are ready to be performed. 132 |

133 |

134 | 135 |

136 | 
137 | function! VimwikiFindIncompleteTasks()
138 |   lvimgrep /- \[ \]/ %:p
139 |   lopen
140 | endfunction
141 | 
142 | function! VimwikiFindAllIncompleteTasks()
143 |   VimwikiSearch /- \[ \]/
144 |   lopen
145 | endfunction
146 | 
147 | nmap <Leader>wa :call VimwikiFindAllIncompleteTasks()<CR>
148 | nmap <Leader>wx :call VimwikiFindIncompleteTasks()<CR>
149 |
150 |

151 | 152 |

153 |

154 |

155 | 156 |

157 |

158 | If you want to encrypt singe pages of your wiki you can use vim gnupg in 159 |

160 |

161 | conjunction with vimwiki. Add the following to your vimrc: 162 |

163 |

164 | 165 |

166 | 
167 | let g:GPGFilePattern = '*.\(gpg\|asc\|pgp\)\(.wiki\)\='
168 |
169 |

170 | 171 |

172 |

173 | Then you can create a link to a page in the following form: [[link.asc]], the 174 |

175 |

176 | resulting file "link.asc.wiki" will be transparently encrypted by vim-gnupg. 177 |

178 |

179 | vim-gnupg will ask you to choose a key and gpg-agent will ask you to unlock the 180 |

181 |

182 | chosen key. 183 |

184 |

185 | 186 |

187 |

188 | Note: If you use a different file-extension for your wikipages make sure to 189 |

190 |

191 | change the code above accordingly. 192 |

193 |

194 | 195 |

196 |

197 |

198 | Vimwiki has no support built in yet, but see this issue for workarounds. 199 |

200 |

201 | 202 |

203 |

204 |

205 | 206 |

207 |

208 |

209 |

210 | You have to configure your wiki(s) in your vimrc, then you can configure among 211 |

212 |

213 | other the folder. 214 |

215 |

216 | 217 |

218 | 
219 | let g:vimwiki_list = [{'path': '~/mywiki/',
220 |                       \ 'path_html': '~/mywiki_html'}]
221 |
222 |

223 | 224 |

225 |

226 |

227 | Yes: 228 |

229 |

230 | 231 |

232 | 
233 | $ vim -c VimwikiIndex
234 |
235 |

236 | 237 |

238 |

239 | Opening the file of a wikipage also does the trick, that way you can open it 240 |

241 |

242 | with another than your main page. Example: 243 |

244 |

245 | 246 |

247 | 
248 | $ alias importantpage='vim vimwiki/importantpage.wiki'
249 | $ importantpage
250 |
251 |

252 | 253 |

254 |

255 |

256 | 257 |

258 |

259 | If you init your vimwiki directory as a git repo, and add the following function 260 |

261 |

262 | to your .bashrc or .zshrc, you can interact with the repo using the command 263 |

264 |

265 | vimwiki git [commands] from any directory: 266 |

267 |

268 | 269 |

270 | 
271 | vimwiki () {
272 |     if [[ $# == 0 ]]
273 |     then
274 |         nvim +'VimwikiIndex'
275 |     elif [[ $1 == 'git' ]]
276 |     then
277 |         git -C ~/vimwiki/ ${@:2}
278 |     else
279 |         echo 'Usage: vimwiki [git] [args ...]'
280 |     fi
281 | }
282 |
283 |

284 | 285 |

286 |

287 | For Fish, add the following function to your config.fish: 288 |

289 |

290 | 291 |

292 | 
293 | function vimwiki 
294 |     if test (count $argv) -eq 0
295 |         vim +"VimwikiIndex"
296 |     else if test $argv[1] = "git"
297 |         git -C ~/vimwiki/ $argv[2..-1]
298 |     else
299 |         echo "Usage: vimwiki [git] [args ...]"
300 |     end
301 | end
302 |
303 |

304 | 305 |

306 |

307 | In addition, calling vimwiki without a git subcommand will automatically open 308 |

309 |

310 | the index. 311 |

312 |

313 | 314 |

315 |

316 |

317 | 318 |

319 |

320 |

321 | You have to configure your wiki(s) in your vimrc, then you can configure syntax 322 |

323 |

324 | and file extension. To set them to markdown and .md add the following 325 |

326 |

327 | configuration to you vimrc: 328 |

329 |

330 | 331 |

332 | 
333 | let g:vimwiki_list = [{'path': '~/vimwiki/',
334 |                       \ 'syntax': 'markdown', 'ext': '.md'}]
335 |
336 |

337 | 338 |

339 |

340 |

341 | 342 |

343 |

344 | Vimwiki has a feature called "Temporary Wikis", that will treat every file with 345 |

346 |

347 | configured file-extension as a wiki. To disable this feature add this to your vimrc: 348 |

349 |

350 | 351 |

352 | 
353 | let g:vimwiki_global_ext = 0
354 |
355 |

356 | 357 |

358 |

359 | Alternative you can set vimwiki to use markdown syntax but a different 360 |

361 |

362 | file-extension, like the default .wiki. 363 |

364 |

365 | 366 |

367 |

368 |

369 | 370 |

371 |

372 | If you have other snippets you find useful, please share them here on the wiki. 373 |

374 | 375 | 376 | 377 | -------------------------------------------------------------------------------- /docs/Troubleshooting.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Troubleshooting 7 | 8 | 9 | 10 | 11 | 12 |

13 |

14 | 15 |

16 |

17 |

18 | 19 |

20 |

21 | These steps might help to determine if an issue is related to your 22 |

23 |

24 | setup/configuration or if the problem is a bug in Vimwiki. 25 |

26 |

27 | 28 |

29 |
    30 |
  1. 31 | Clone a fresh copy of the dev branch. 32 | 
    33 |     cd $HOME
34 |     mkdir vw_tmp
35 |     cd vw_tmp
36 |     git clone -b dev --single-branch https://github.com/vimwiki/vimwiki.git
37 |
    38 |
    2. 39 |
  2. 40 | Create a minimal vimrc (you should still be in $HOME/vw_tmp) 41 |
    3. 42 |
      43 |
    • 44 | vim min_vimrc 45 |
      • 46 |
    • 47 | Paste the below text into the opened file. Add any additional Vimwiki 48 | settings that are relevant to the issue being tested but keep in minimal! 49 | 
      50 |     set nocompatible
51 |     filetype plugin on
52 |     syntax on
53 |     set runtimepath+=~/vw_tmp/vimwiki
54 |     let wiki = {}
55 |     let wiki.path = '~/vw_tmp/wiki'
56 |     let wiki.path_html = '~/vw_tmp/wiki/html'
57 |     let wiki.syntax = 'default'
58 |     let wiki.ext = '.wiki'
59 |     let g:vimwiki_list = [wiki]
60 |
      61 |
      • 62 |
    63 |
  3. 64 | Start vim using the min_vimrc 65 |
    4. 66 |
      67 |
    • 68 | vim -u min_vimrc 69 |
      • 70 |
    71 |
  4. 72 | Open up Vimwiki (\ww) and verify the issue still occurs. 73 |
    5. 74 |
75 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /docs/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | index 7 | 8 | 9 | 10 | 11 | 12 |

13 |

14 | 15 |

16 |

17 | Welcome to the Vimwiki wiki! 18 |

19 |

20 | 21 |

22 |

23 |

24 | 25 |

26 |

27 | Here are links to the official Vimwiki repositories: 28 |

29 |

30 | 31 |

32 |
    33 |
  • 34 | Vimwiki 35 |
    • 36 |
  • 37 | Vimwiki Wiki (GitHub pages site built using Vimwiki) 38 |
    • 39 | 44 |
  • 45 | Utilities 46 |
    • 47 |
  • 48 | Test wikis - sample wikis in each of 49 | the 3 syntax variants. Used for testing and development. 50 |
    • 51 |
52 |

53 |

54 | 55 |

56 |

57 | Checkout these pages for additional information and tips! 58 |

59 |

60 | 61 |

62 | 73 |

74 |

75 | 76 |

77 | 85 |

86 |

87 | 88 |

89 |

90 | These links point to some old versions of Vimwiki that are no longer maintained. 91 |

92 |

93 | The original Vimwiki was hosted on Google Code which has since shutdown. 94 |

95 |

96 | 97 |

98 | 109 | 110 |

111 | 112 |

113 | 130 | 131 | 132 | 133 | -------------------------------------------------------------------------------- /docs/logos/logo-darker.svg: -------------------------------------------------------------------------------- 1 | 2 | 18 | 20 | 21 | 23 | image/svg+xml 24 | 26 | 27 | 28 | 29 | 31 | 51 | 55 | 59 | 63 | 68 | 73 | 78 | 83 | 90 | 91 | -------------------------------------------------------------------------------- /docs/logos/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/logos/vertical-logo-darker.svg: -------------------------------------------------------------------------------- 1 | 2 | 18 | 20 | 21 | 23 | image/svg+xml 24 | 26 | 27 | 28 | 29 | 30 | 32 | 54 | 59 | 64 | 69 | 74 | 84 | 89 | 94 | 99 | 100 | -------------------------------------------------------------------------------- /docs/logos/vertical-logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 18 | 20 | 21 | 23 | image/svg+xml 24 | 26 | 27 | 28 | 29 | 30 | 32 | 53 | 58 | 63 | 68 | 73 | 83 | 88 | 93 | 98 | 99 | -------------------------------------------------------------------------------- /docs/style.css: -------------------------------------------------------------------------------- 1 | body { 2 | font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;; 3 | margin: 2em 4em 2em 4em; 4 | font-size: 120%; 5 | line-height: 130%; 6 | } 7 | 8 | h1, h2, h3, h4, h5, h6 { 9 | font-weight: bold; 10 | line-height:100%; 11 | margin-top: 1.5em; 12 | margin-bottom: 0.5em; 13 | } 14 | 15 | h1 {font-size: 2em; color: #000000;} 16 | h2 {font-size: 1.8em; color: #404040;} 17 | h3 {font-size: 1.6em; color: #707070;} 18 | h4 {font-size: 1.4em; color: #909090;} 19 | h5 {font-size: 1.2em; color: #989898;} 20 | h6 {font-size: 1em; color: #9c9c9c;} 21 | 22 | p, pre, blockquote, table, ul, ol, dl { 23 | margin-top: 1em; 24 | margin-bottom: 1em; 25 | } 26 | 27 | ul ul, ul ol, ol ol, ol ul { 28 | margin-top: 0.5em; 29 | margin-bottom: 0.5em; 30 | } 31 | 32 | li { margin: 0.3em auto; } 33 | 34 | ul { 35 | margin-left: 2em; 36 | padding-left: 0; 37 | } 38 | 39 | dt { font-weight: bold; } 40 | 41 | img { border: none; } 42 | 43 | pre { 44 | border-left: 5px solid #dcdcdc; 45 | background-color: #f5f5f5; 46 | padding-left: 1em; 47 | font-family: Monaco, "Courier New", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", monospace; 48 | font-size: 0.8em; 49 | border-radius: 6px; 50 | } 51 | 52 | p > a { 53 | color: white; 54 | text-decoration: none; 55 | font-size: 0.7em; 56 | padding: 3px 6px; 57 | border-radius: 3px; 58 | background-color: #1e90ff; 59 | text-transform: uppercase; 60 | font-weight: bold; 61 | } 62 | 63 | p > a:hover { 64 | color: #dcdcdc; 65 | background-color: #484848; 66 | } 67 | 68 | li > a { 69 | color: #1e90ff; 70 | font-weight: bold; 71 | text-decoration: none; 72 | } 73 | 74 | li > a:hover { color: #ff4500; } 75 | 76 | blockquote { 77 | color: #686868; 78 | font-size: 0.8em; 79 | line-height: 120%; 80 | padding: 0.8em; 81 | border-left: 5px solid #dcdcdc; 82 | } 83 | 84 | th, td { 85 | border: 1px solid #ccc; 86 | padding: 0.3em; 87 | } 88 | 89 | th { background-color: #f0f0f0; } 90 | 91 | hr { 92 | border: none; 93 | border-top: 1px solid #ccc; 94 | width: 100%; 95 | } 96 | 97 | del { 98 | text-decoration: line-through; 99 | color: #777777; 100 | } 101 | 102 | .toc li { list-style-type: none; } 103 | 104 | .todo { 105 | font-weight: bold; 106 | background-color: #ff4500 ; 107 | color: white; 108 | font-size: 0.8em; 109 | padding: 3px 6px; 110 | border-radius: 3px; 111 | } 112 | 113 | .justleft { text-align: left; } 114 | .justright { text-align: right; } 115 | .justcenter { text-align: center; } 116 | 117 | .center { 118 | margin-left: auto; 119 | margin-right: auto; 120 | } 121 | 122 | .tag { 123 | background-color: #eeeeee; 124 | font-family: monospace; 125 | padding: 2px; 126 | } 127 | 128 | .header a { 129 | text-decoration: none; 130 | color: inherit; 131 | } 132 | 133 | /* classes for items of todo lists */ 134 | 135 | .rejected { 136 | /* list-style: none; */ 137 | background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAMAAAAMCGV4AAAACXBIWXMAAADFAAAAxQEdzbqoAAAAB3RJTUUH4QgEFhAtuWgv9wAAAPZQTFRFmpqam5iYnJaWnJeXnpSUn5OTopCQpoqKpouLp4iIqIiIrYCAt3V1vW1tv2xsmZmZmpeXnpKS/x4e/x8f/yAg/yIi/yQk/yUl/yYm/ygo/ykp/yws/zAw/zIy/zMz/zQ0/zU1/zY2/zw8/0BA/0ZG/0pK/1FR/1JS/1NT/1RU/1VV/1ZW/1dX/1pa/15e/19f/2Zm/2lp/21t/25u/3R0/3p6/4CA/4GB/4SE/4iI/46O/4+P/52d/6am/6ur/66u/7Oz/7S0/7e3/87O/9fX/9zc/93d/+Dg/+vr/+3t/+/v//Dw//Ly//X1//f3//n5//z8////gzaKowAAAA90Uk5T/Pz8/Pz8/Pz8/Pz8/f39ppQKWQAAAAFiS0dEEnu8bAAAAACuSURBVAhbPY9ZF4FQFEZPSKbIMmWep4gMGTKLkIv6/3/GPbfF97b3w17rA0kQOPgvAeHW6uJ6+5h7HqLdwowgOzejXRXBdx6UdSru216xuOMBHHNU0clTzeSUA6EhF8V8kqroluMiU6HKcuf4phGPr1o2q9kYZWwNq1qfRRmTaXpqsyjj17KkWCxKBUBgXWueHIyiAIg18gsse4KHkLF5IKIY10WQgv7fOy4ST34BRiopZ8WLNrgAAAAASUVORK5CYII=); 138 | background-repeat: no-repeat; 139 | background-position: 0 .2em; 140 | padding-left: 1.5em; 141 | } 142 | .done0 { 143 | /* list-style: none; */ 144 | background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAA7SURBVCiR7dMxEgAgCANBI3yVRzF5KxNbW6wsuH7LQ2YKQK1mkswBVERYF5Os3UV3gwd/jF2SkXy66gAZkxS6BniubAAAAABJRU5ErkJggg==); 145 | background-repeat: no-repeat; 146 | background-position: 0 .2em; 147 | padding-left: 1.5em; 148 | } 149 | .done1 { 150 | background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAABtSURBVCiR1ZO7DYAwDER9BDmTeZQMFXmUbGYpOjrEryA0wOvO8itOslFrJYAug5BMM4BeSkmjsrv3aVTa8p48Xw1JSkSsWVUFwD05IqS1tmYzk5zzae9jnVVVzGyXb8sALjse+euRkEzu/uirFomVIdDGOLjuAAAAAElFTkSuQmCC); 151 | background-repeat: no-repeat; 152 | background-position: 0 .15em; 153 | padding-left: 1.5em; 154 | } 155 | .done2 { 156 | background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAB1SURBVCiRzdO5DcAgDAVQGxjAYgTvxlDIu1FTIRYAp8qlFISkSH7l5kk+ZIwxKiI2mIyqWoeILYRgZ7GINDOLjnmF3VqklKCUMgTee2DmM661Qs55iI3Zm/1u5h9sm4ig9z4ERHTFzLyd4G4+nFlVrYg8+qoF/c0kdpeMsmcAAAAASUVORK5CYII=); 157 | background-repeat: no-repeat; 158 | background-position: 0 .15em; 159 | padding-left: 1.5em; 160 | } 161 | .done3 { 162 | background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAABoSURBVCiR7dOxDcAgDATA/0DtUdiKoZC3YhLkHjkVKF3idJHiztKfvrHZWnOSE8Fx95RJzlprimJVnXktvXeY2S0SEZRSAAAbmxnGGKH2I5T+8VfxPhIReQSuuY3XyYWa3T2p6quvOgGrvSFGlewuUAAAAABJRU5ErkJggg==); 163 | background-repeat: no-repeat; 164 | background-position: 0 .15em; 165 | padding-left: 1.5em; 166 | } 167 | .done4 { 168 | background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABIAAAAQCAYAAAAbBi9cAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAzgAAAM4BlP6ToAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAIISURBVDiNnZQ9SFtRFMd/773kpTaGJoQk1im4VDpWQcTNODhkFBcVTCNCF0NWyeDiIIiCm82QoIMIUkHUxcFBg1SEQoZszSat6cdTn1qNue92CMbEr9Sey+XC/Z/zu+f8h6ukUil3sVg0+M+4cFxk42/jH2wAqqqKSCSiPQdwcHHAnDHH9s/tN1h8V28ETdP+eU8fT9Nt62ancYdIPvJNtsu87bmjrJlrTDVM4RROJs1JrHPrD4Bar7A6cpc54iKOaTdJXCUI2UMVrQZ0Js7YPN18ECKkYNQcJe/OE/4dZsw7VqNXQMvHy3QZXQypQ6ycrtwDjf8aJ+PNEDSCzLpn7+m2pD8ZKHlKarYhy6XjEoCYGcN95qansQeA3fNdki+SaJZGTMQIOoL3W/Z89rxv+tokubNajlvk/vm+LFpF2XnUKZHI0I+QrI7Dw0OZTqdzUkpsM7mZTyfy5OPGyw1tK7AFSvmB/Ks8w8YwbUYbe6/3QEKv0vugfxWPnMLJun+d/kI/WLdizpNjMbAIKrhMF4OuwadBALqqs+RfInwUvuNi+fBd+wjogfogAFVRmffO02q01mZZ0HHdgXIzdz0QQLPezIQygX6llxNKKgOFARYCC49CqhoHIUTlss/Vx2phlYwjw8j1CAlfAiwQiJpiy7o1VHnsG5FISkoJu7Q/2YmmaV+i0ei7v38L2CBguSi5AAAAAElFTkSuQmCC); 169 | background-repeat: no-repeat; 170 | background-position: 0 .15em; 171 | padding-left: 1.5em; 172 | } 173 | 174 | code { 175 | font-family: Monaco, "Courier New", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", monospace; 176 | -webkit-border-radius: 1px; 177 | -moz-border-radius: 1px; 178 | border-radius: 1px; 179 | -moz-background-clip: padding; 180 | -webkit-background-clip: padding-box; 181 | background-clip: padding-box; 182 | padding: 0px 3px; 183 | display: inline-block; 184 | color: #52595d; 185 | border: 1px solid #ccc; 186 | background-color: #f9f9f9; 187 | } 188 | -------------------------------------------------------------------------------- /wiki/Related Tools.wiki: -------------------------------------------------------------------------------- 1 | = Related Tools = 2 | 3 | This page contains Vim plugins and external tools that can be used with Vimwiki. 4 | These lists are incomplete so please _help update them_ if you know of something 5 | that is missing! 6 | 7 | == Vim Plugins == 8 | 9 | - [[https://github.com/mattn/calendar-vim|calendar-vim]] 10 | - Select a date to open a diary page. 11 | - [[https://github.com/qadzek/link.vim|link.vim]] 12 | - Keep long URLs out of your way in Vimwiki (Markdown syntax). 13 | - [[https://github.com/tbabej/taskwiki|taskwiki]] 14 | - Integration with [[https://taskwarrior.org/|taskwarrior]] for task 15 | management. This only supports the default syntax. 16 | - [[https://github.com/majutsushi/tagbar|Tagbar]] 17 | - Creates a sidebar to view generated tags. For Vimwiki this can be 18 | used to display links to headers. 19 | - For this to work an [[https://raw.githubusercontent.com/vimwiki/utils/master/vwtags.py|additional script]] 20 | is needed which is available in the [[https://github.com/vimwiki/utils|utility repository]]. 21 | Additional instructions are in the comments of the script. 22 | - If using Markdown syntax `#` symbols used within code blocks are 23 | recognized as a header i.e. in a shell script snippet. An alternative 24 | version that works for Markdown can be found 25 | [[https://raw.githubusercontent.com/jszakmeister/markdown2ctags/master/markdown2ctags.py|here]]. 26 | - [[https://github.com/teranex/vimwiki-tasks|vimwiki-tasks]] 27 | - Another integration with [[https://taskwarrior.org/|taskwarrior]]. This 28 | plugin does not seem to be maintained any longer. 29 | - [[https://github.com/matt-snider/vim-tagquery|vim-tagquery]] 30 | - A vim plugin that enables improved querying of tags. 31 | - This can be used to search for multiple tags. 32 | - See [[https://github.com/vimwiki/vimwiki/issues/723|Issue #723]] 33 | - [[https://github.com/gpanders/vim-medieval|vim-medieval]] 34 | - Evaluate Markdown code blocks within Vim to scrathpad, or inline code block within the file 35 | - Works for vimwiki syntax, see [[https://github.com/gpanders/vim-medieval/wiki|configuration wiki page]] 36 | - Can be used for literate programming 37 | - [[https://github.com/dhruvasagar/vim-table-mode|vim-table-mode]] 38 | - Add formulas to Markdown tables 39 | - Works for vimwiki syntax, see [[https://gist.github.com/MartyLake/f6dd46bb479d402b15b32791ababaa28|configuration gist example]] 40 | 41 | == External Tools == 42 | 43 | - [[https://github.com/vimwiki/vimwiki/blob/master/autoload/vimwiki/customwiki2html.sh|customwiki2html.sh]] 44 | - Script available in the official repository to convert Markdown to HTML. 45 | - See the comments for more information and usage instructions. 46 | - [[https://pandoc.org/MANUAL.html|Pandoc]] 47 | - Convert Vimwiki to various other formats such as HTML, PDF, etc. 48 | - [[https://github.com/patrickdavey/vimwiki_markdown|vimwiki_markdown]] 49 | - A Ruby gem to convert vimwiki Markdown files to HTML. Still being actively 50 | developed. 51 | - [[https://github.com/WnP/vimwiki_markdown|vimwiki_markdown Python]] 52 | - A Python script to convert Markdown files to HTML. 53 | - Also see [[https://github.com/vimwiki/vimwiki/issues/578|Issue #578]] 54 | - [[https://github.com/maqiv/vimwiki-godown#todo|vimwiki-godown]] 55 | - HTML converter that adds the ability to prefix relative links to other 56 | Vimwiki pages 57 | - See [[https://github.com/vimwiki/vimwiki/issues/284|Issue #284]] 58 | - [[https://github.com/sstallion/vimwiki-skel|vimwiki-skel]] 59 | - Uses [[https://dynalon.github.io/mdwiki/#!index.md|MDWiki]] to convert 60 | Markdown files to HTML. 61 | - [[https://gist.github.com/maikeldotuk/54a91c21ed9623705fdce7bab2989742|wiki2html.sh Gist]] 62 | - Uses Pandoc to convert Markdown files to HTML. 63 | - [[https://github.com/fasheng/vimwiki2org|vimwiki2org]] 64 | - Convert vimwiki to [[https://orgmode.org/|Emacs orgmode]]. Has not been 65 | updated in 6 years. 66 | - [[https://github.com/ycpei/vwweb|vwweb]] 67 | - Python script to generate a website from Vimwiki files. 68 | - [[https://box.matto.nl/vimwikijabberbot.html|vimwiki-todo-jabberbot]] 69 | - Todo management using Jabberbot. The linked GitHub repository seems to 70 | have been removed. 71 | - [[https://github.com/zweifisch/vimwiki-tools|vimwiki-tools]] 72 | - Python tool to generate an index and convert wiki files to Markdown 73 | format. This has not been updated in 6 years. 74 | - [[https://github.com/sstallion/vimwiki-cli|vimwiki-cli]] 75 | - Python CLI that provides a front-end for interactive editor commands and 76 | can be used to automate repetitive tasks such as rebuilding tag metadata 77 | and generating links, all from the command line. 78 | -------------------------------------------------------------------------------- /wiki/Tips and Snips.wiki: -------------------------------------------------------------------------------- 1 | = Tips and Snips = 2 | 3 | Vimwiki cannot be all things to all users so here are some tips and code 4 | snippets you may find useful for customizing Vimwiki to your liking. 5 | 6 | == Cheat Sheet == 7 | There are several cheat sheets for Vimwiki: 8 | - [[http://thedarnedestthing.com/vimwiki%20cheatsheet|The Darnedest Thing - Vimwiki Cheatsheet]] 9 | - [[https://gist.github.com/drkarl/4c503bccb62558dc85e8b1bc0f29e9cb|Short Cheatsheet]] 10 | - [[https://dokk.org/library/vimwiki_1.1.1_quick_reference_Posp%C3%ADchal_2011|PDF Cheatsheet incl. Syntax]] 11 | 12 | == Custom folding == 13 | 14 | Vimwiki has simple folding folding methods built in but lets you easily 15 | customize folds with the `g:vimwiki_folding` option. For example, if you prefer 16 | that the last blank line before a heading not get folded, add this to your 17 | `.vimrc` file: 18 | 19 | `let g:vimwiki_folding = 'custom'` 20 | 21 | Then add the following to the `ftplugin/vimwiki.vim` plugin in your `.vim` 22 | configuration folder (create this file if it doesn't already exist): 23 | 24 | {{{vim 25 | let l:vimwiki_fold_blank_lines = 0 " set to 1 to fold blank lines 26 | let l:vimwiki_header_type = '#' " set to '=' for wiki syntax 27 | setlocal foldlevel=1 28 | setlocal foldenable 29 | setlocal foldmethod=expr 30 | setlocal foldexpr=Fold(v:lnum) 31 | 32 | function! Fold(lnum) 33 | let fold_level = strlen(matchstr(getline(a:lnum), '^' . l:vimwiki_header_type . '\+')) 34 | if (fold_level) 35 | return '>' . fold_level " start a fold level 36 | endif 37 | if getline(a:lnum) =~? '\v^\s*$' 38 | if (strlen(matchstr(getline(a:lnum + 1), '^' . l:vimwiki_header_type . '\+')) > 0 && !g:vimwiki_fold_blank_lines) 39 | return '-1' " don't fold last blank line before header 40 | endif 41 | endif 42 | return '=' " return previous fold level 43 | endfunction 44 | }}} 45 | 46 | == Task Management == 47 | 48 | Vimwiki makes it effortless to add tasks to any wiki page. Unfortunately, 49 | this means that your tasks get dispersed rather widely, especially if 50 | you're tracking action items from meeting notes in your diary. The snippets 51 | below make it easier to manage tasks in vimwiki without adding any additional 52 | plugins or relying on external task management tools. 53 | 54 | === Find Incomplete Tasks === 55 | 56 | The following will open a QuickFix window with incomplete tasks, but only those 57 | which are in a hyphenated (`-`) list. This is a simple way to filter only on 58 | tasks which are ready to be performed. 59 | 60 | {{{vim 61 | function! VimwikiFindIncompleteTasks() 62 | lvimgrep /- \[ \]/ %:p 63 | lopen 64 | endfunction 65 | 66 | function! VimwikiFindAllIncompleteTasks() 67 | VimwikiSearch /- \[ \]/ 68 | lopen 69 | endfunction 70 | 71 | nmap wa :call VimwikiFindAllIncompleteTasks() 72 | nmap wx :call VimwikiFindIncompleteTasks() 73 | }}} 74 | 75 | == Encrypting Vimwiki pages == 76 | 77 | If you want to encrypt singe pages of your wiki you can use [[https://github.com/jamessan/vim-gnupg|vim gnupg]] in 78 | conjunction with vimwiki. Add the following to your `vimrc`: 79 | 80 | {{{vim 81 | let g:GPGFilePattern = '*.\(gpg\|asc\|pgp\)\(.wiki\)\=' 82 | }}} 83 | 84 | Then you can create a link to a page in the following form: `[[link.asc]]`, the 85 | resulting file "link.asc.wiki" will be transparently encrypted by vim-gnupg. 86 | vim-gnupg will ask you to choose a key and gpg-agent will ask you to unlock the 87 | chosen key. 88 | 89 | Note: If you use a different file-extension for your wikipages make sure to 90 | change the code above accordingly. 91 | 92 | == Cite entries from bibtex library == 93 | Vimwiki has no support built in yet, but see [[https://github.com/vimwiki/vimwiki/issues/361|this issue]] for workarounds. 94 | 95 | == Finding Orphans == 96 | 97 | Here's a handy Bash script to detect any .wiki orphans in the current directory. It will output all .wiki files that have no links to them. (Dependency: `rg`.) 98 | 99 | {{{sh 100 | escapethese='?()' 101 | for f in *.wiki; do 102 | [ "$f" = 'index.wiki' ] && continue 103 | vwname="$(basename "$f" .wiki | sed "s/[${escapethese}]/\\\\&/g")" 104 | if ! rg "\[\[$vwname([|#].*)?\]\]" > /dev/null; then 105 | echo "$f" 106 | j fi 107 | done 108 | }}} 109 | 110 | == FAQ == 111 | 112 | === General === 113 | ==== How to change the folder of the wiki? ==== 114 | You have to configure your wiki(s) in your vimrc, then you can configure among 115 | other the folder. 116 | 117 | {{{vim 118 | let g:vimwiki_list = [{'path': '~/mywiki/', 119 | \ 'path_html': '~/mywiki_html'}] 120 | }}} 121 | 122 | ==== Can I start Vimwiki directly from shell? ==== 123 | Yes: 124 | 125 | {{{bash 126 | $ vim -c VimwikiIndex 127 | }}} 128 | 129 | Opening the file of a wikipage also does the trick, that way you can open it 130 | with another than your main page. Example: 131 | 132 | {{{bash 133 | $ alias importantpage='vim vimwiki/importantpage.wiki' 134 | $ importantpage 135 | }}} 136 | 137 | ==== Useful shell function for git integration and launch ==== 138 | 139 | If you init your vimwiki directory as a git repo, and add the following function 140 | to your `.bashrc` or `.zshrc`, you can interact with the repo using the command 141 | `vimwiki git [commands]` from any directory: 142 | 143 | {{{bash 144 | vimwiki () { 145 | if [[ $# == 0 ]] 146 | then 147 | nvim +'VimwikiIndex' 148 | elif [[ $1 == 'git' ]] 149 | then 150 | git -C ~/vimwiki/ ${@:2} 151 | else 152 | echo 'Usage: vimwiki [git] [args ...]' 153 | fi 154 | } 155 | }}} 156 | 157 | For Fish, add the following function to your `config.fish`: 158 | 159 | {{{fish 160 | function vimwiki 161 | if test (count $argv) -eq 0 162 | vim +"VimwikiIndex" 163 | else if test $argv[1] = "git" 164 | git -C ~/vimwiki/ $argv[2..-1] 165 | else 166 | echo "Usage: vimwiki [git] [args ...]" 167 | end 168 | end 169 | }}} 170 | 171 | In addition, calling `vimwiki` without a git subcommand will automatically open 172 | the index. 173 | 174 | === Markdown === 175 | 176 | ==== How do I use markdown syntax for my wikis? ==== 177 | You have to configure your wiki(s) in your vimrc, then you can configure syntax 178 | and file extension. To set them to markdown and `.md` add the following 179 | configuration to you vimrc: 180 | 181 | {{{vim 182 | let g:vimwiki_list = [{'path': '~/vimwiki/', 183 | \ 'syntax': 'markdown', 'ext': '.md'}] 184 | }}} 185 | 186 | ==== Vimwiki considers every markdown-file as a wiki file ==== 187 | 188 | Vimwiki has a feature called "Temporary Wikis", that will treat every file with 189 | configured file-extension as a wiki. To disable this feature add this to your vimrc: 190 | 191 | {{{vim 192 | let g:vimwiki_global_ext = 0 193 | }}} 194 | 195 | Alternative you can set vimwiki to use markdown syntax but a different 196 | file-extension, like the default `.wiki`. 197 | 198 | == Got Other Great Ideas You'd Like to Share? == 199 | 200 | If you have other snippets you find useful, please share them here on the wiki. 201 | -------------------------------------------------------------------------------- /wiki/Troubleshooting.wiki: -------------------------------------------------------------------------------- 1 | = Troubleshooting = 2 | 3 | == Minimal Vimrc == 4 | 5 | These steps might help to determine if an issue is related to your 6 | setup/configuration or if the problem is a bug in Vimwiki. 7 | 8 | 1. Clone a fresh copy of the `dev` branch. 9 | {{{sh 10 | cd $HOME 11 | mkdir vw_tmp 12 | cd vw_tmp 13 | git clone -b dev --single-branch https://github.com/vimwiki/vimwiki.git 14 | }}} 15 | 2. Create a minimal `vimrc` (you should still be in `$HOME/vw_tmp`) 16 | - `vim min_vimrc` 17 | - Paste the below text into the opened file. Add any additional Vimwiki 18 | settings that are relevant to the issue being tested but keep in minimal! 19 | {{{vim 20 | set nocompatible 21 | filetype plugin on 22 | syntax on 23 | set runtimepath+=~/vw_tmp/vimwiki 24 | let wiki = {} 25 | let wiki.path = '~/vw_tmp/wiki' 26 | let wiki.path_html = '~/vw_tmp/wiki/html' 27 | let wiki.syntax = 'default' 28 | let wiki.ext = '.wiki' 29 | let g:vimwiki_list = [wiki] 30 | }}} 31 | 3. Start vim using the `min_vimrc` 32 | - `vim -u min_vimrc` 33 | 4. Open up Vimwiki (`\ww`) and verify the issue still occurs. 34 | -------------------------------------------------------------------------------- /wiki/index.wiki: -------------------------------------------------------------------------------- 1 | = Vimwiki Wiki = 2 | 3 | *Welcome to the Vimwiki wiki!* 4 | 5 | == Official Repositories == 6 | 7 | Here are links to the official Vimwiki repositories: 8 | 9 | - [[https://github.com/vimwiki/vimwiki|Vimwiki]] 10 | - [[https://vimwiki.github.io/vimwikiwiki/|Vimwiki Wiki]] (GitHub pages site built using Vimwiki) 11 | - [[https://github.com/vimwiki/vimwikiwiki|source repository]] 12 | - [[https://github.com/vimwiki/utils|Utilities]] 13 | - [[https://github.com/vimwiki/testwikis|Test wikis]] - sample wikis in each of 14 | the 3 syntax variants. Used for testing and development. 15 | 16 | == Wiki Pages == 17 | 18 | Checkout these pages for additional information and tips! 19 | 20 | - [[Tips and Snips]] 21 | - [[Related Tools]] 22 | - [[Troubleshooting]] 23 | 24 | == Chat/Forums == 25 | 26 | - [[https://groups.google.com/forum/#!forum/vimwiki|Google Vimwiki group]] 27 | - [[https://web.libera.chat/?channels=#vimwiki|Libera.Chat Webchat]] 28 | 29 | == Outdated Versions == 30 | 31 | These links point to some old versions of Vimwiki that are no longer maintained. 32 | The original Vimwiki was hosted on Google Code which has since shutdown. 33 | 34 | - [[https://code.google.com/archive/p/vimwiki/|Google Code Archive]] 35 | - [[https://github.com/vimwiki-backup/vimwiki|Google Code Backup on Github]] 36 | - [[https://www.vim.org/scripts/script.php?script_id=2226|Vimwiki on vim.org]] 37 | 38 | == Related Projects == 39 | 40 | - [[https://github.com/lervag/wiki.vim|wiki.vim]] 41 | - [[https://github.com/fcpg/vim-waikiki|vim-waikiki]] 42 | - [[https://github.com/jceb/vim-orgmode|vim-orgmode]] 43 | - [[https://github.com/tbabej/taskwiki|taskwiki]] 44 | - [[https://github.com/xolox/vim-notes|vim-notes]] 45 | --------------------------------------------------------------------------------