Compare commits
7 Commits
v2024.01.22
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
| 72792615e7 | |||
| 5cca07970c | |||
| 705ad1e0dd | |||
| 7ad424ea42 | |||
| 69318e74c8 | |||
| fde35bb87e | |||
| 2d17e6147b |
@@ -28,7 +28,6 @@ VimWiki is a personal wiki for Vim -- a number of linked text files that have
|
||||
their own syntax highlighting. See the [VimWiki Wiki](https://vimwiki.github.io/vimwikiwiki/)
|
||||
for an example website built with VimWiki!
|
||||
|
||||
For the latest features and fixes checkout the [dev branch](https://github.com/vimwiki/vimwiki/tree/dev).
|
||||
If you are interested in contributing see [this section](#helping-vimwiki).
|
||||
|
||||
With VimWiki, you can:
|
||||
@@ -40,8 +39,8 @@ With VimWiki, you can:
|
||||
- Export everything to HTML
|
||||
|
||||
To do a quick start, press `<Leader>ww` (default is `\ww`) to go to your index
|
||||
wiki file. By default, it is located in `~/vimwiki/index.wiki`. See `:h vimwiki_list`
|
||||
for registering a different path/wiki.
|
||||
wiki file. By default, it is located in `~/vimwiki/index.wiki`. See
|
||||
`:h vimwiki_list` for registering a different path/wiki.
|
||||
|
||||
Feed it with the following example:
|
||||
|
||||
@@ -77,8 +76,10 @@ The result should look something like:
|
||||
|
||||
## Installation
|
||||
|
||||
VimWiki has been tested on **Vim >= 7.3**. It will likely work on older
|
||||
versions but will not be officially supported.
|
||||
VimWiki has been tested on **Vim >= 7.3**. It may work on older versions but
|
||||
will not be officially supported. It is known to work on NeoVim, although
|
||||
it is likely to have
|
||||
[NeoVim-specific bugs](https://github.com/vimwiki/vimwiki/labels/neovim).
|
||||
|
||||
### Prerequisites
|
||||
|
||||
@@ -143,7 +144,7 @@ vim +PluginInstall +qall
|
||||
|
||||
#### Manual Install
|
||||
|
||||
Download the [zip archive](https://github.com/vimwiki/vimwiki/archive/master.zip)
|
||||
Download the [zip archive](https://github.com/vimwiki/vimwiki/archive/dev.zip)
|
||||
and extract it in `~/.vim/bundle/`
|
||||
|
||||
Then launch Vim, run `:Helptags` and then `:help vimwiki` to verify it was
|
||||
@@ -185,6 +186,16 @@ _italic_ -- italic text
|
||||
|
||||
For other syntax elements, see `:h vimwiki-syntax`
|
||||
|
||||
### Todo lists
|
||||
|
||||
```text
|
||||
- [.] Partially completed item with sub-tasks
|
||||
- [X] Completed sub-task
|
||||
- [ ] Incomplete sub-task
|
||||
- [ ] Other incomplete sub-task
|
||||
- [ ] Incomplete item
|
||||
```
|
||||
|
||||
## Key bindings
|
||||
|
||||
### Normal mode
|
||||
@@ -222,11 +233,13 @@ more bindings.
|
||||
## Changing Wiki Syntax
|
||||
|
||||
VimWiki currently ships with 3 syntaxes: VimWiki (default), Markdown
|
||||
(markdown), and MediaWiki (media).
|
||||
(markdown), and MediaWiki (media). Of these, the native VimWiki syntax is
|
||||
best supported, followed by Markdown. No promises are made for MediaWiki.
|
||||
|
||||
**NOTE:** Only the default syntax ships with a built-in HTML converter. For
|
||||
Markdown or MediaWiki see `:h vimwiki-option-custom_wiki2html`. Some examples
|
||||
and 3rd party tools are available [here](https://vimwiki.github.io/vimwikiwiki/Related%20Tools.html#Related%20Tools-External%20Tools).
|
||||
and 3rd party tools are available
|
||||
[here](https://vimwiki.github.io/vimwikiwiki/Related%20Tools.html#Related%20Tools-External%20Tools).
|
||||
|
||||
If you would prefer to use either Markdown or MediaWiki syntaxes, set the
|
||||
following option in your `.vimrc`:
|
||||
@@ -238,20 +251,27 @@ let g:vimwiki_list = [{'path': '~/vimwiki/',
|
||||
|
||||
```
|
||||
|
||||
This option will treat all markdown files in your system as part of vimwiki (check `set filetype?`). Add
|
||||
This option will treat all markdown files in your system as part of vimwiki
|
||||
(check `set filetype?`). Add
|
||||
|
||||
```vim
|
||||
let g:vimwiki_global_ext = 0
|
||||
```
|
||||
to your `.vimrc` to restrict Vimwiki's operation to only those paths listed in `g:vimwiki_list`.
|
||||
Other markdown files wouldn't be treated as wiki pages.
|
||||
|
||||
to your `.vimrc` to restrict Vimwiki's operation to only those paths listed in
|
||||
`g:vimwiki_list`. Other markdown files wouldn't be treated as wiki pages.
|
||||
See [g:vimwiki_global_ext](https://github.com/vimwiki/vimwiki/blob/619f04f89861c58e5a6415a4f83847752928252d/doc/vimwiki.txt#L2631).
|
||||
|
||||
if you want to turn off support for other extension(for example, disabling accidently creating new wiki and link for normal markdown files),
|
||||
set the following option in your `.vimrc` before packadd vimwiki:
|
||||
if you want to turn off support for other extension(for example, disabling
|
||||
accidently creating new wiki and link for normal markdown files), set the
|
||||
following option in your `.vimrc` before packadd vimwiki:
|
||||
|
||||
```vim
|
||||
let g:vimwiki_ext2syntax = {}
|
||||
```
|
||||
|
||||
See [g:vimiki_ext2syntax](https://github.com/vimwiki/vimwiki/blob/619f04f89861c58e5a6415a4f83847752928252d/doc/vimwiki.txt#L2652)
|
||||
|
||||
## Getting help
|
||||
|
||||
[GitHub issues](https://github.com/vimwiki/vimwiki/issues) are the primary
|
||||
@@ -259,18 +279,20 @@ method for raising bug reports or feature requests.
|
||||
|
||||
Additional resources:
|
||||
|
||||
- The IRC channel [#vimwiki](ircs://irc.libera.chat:6697/vimwiki) on irc.libera.chat
|
||||
- The IRC channel [#vimwiki](ircs://irc.libera.chat:6697/vimwiki) on
|
||||
irc.libera.chat is the "official" discussion and support channel
|
||||
- [Connect via webchat](https://web.libera.chat/?channels=#vimwiki)
|
||||
- Connect via Matrix/Element: [#vimwiki:libera.chat](https://matrix.to/#/#vimwiki:libera.chat)
|
||||
- Post to the [mailing list](https://groups.google.com/forum/#!forum/vimwiki).
|
||||
- [@vimwiki@wikis.world](https://wikis.world/@vimwiki) on the Fediverse
|
||||
|
||||
## Helping VimWiki
|
||||
|
||||
VimWiki has a lot of users but only very few recurring developers or people
|
||||
helping the community. Your help is therefore appreciated. Everyone can help!
|
||||
See [#625](https://github.com/vimwiki/vimwiki/issues/625) for information on how you can help.
|
||||
See [#625](https://github.com/vimwiki/vimwiki/issues/625) for information on how
|
||||
you can help.
|
||||
|
||||
Also, take a look at [CONTRIBUTING.md](https://github.com/vimwiki/vimwiki/blob/master/CONTRIBUTING.md) and [design_notes.md](doc/design_notes.md)
|
||||
Also, take a look at [CONTRIBUTING.md](https://github.com/vimwiki/vimwiki/blob/master/CONTRIBUTING.md)
|
||||
and [design_notes.md](doc/design_notes.md)
|
||||
|
||||
----
|
||||
|
||||
|
||||
@@ -262,11 +262,20 @@ function! vimwiki#base#resolve_link(link_text, ...) abort
|
||||
\ vimwiki#vars#get_wikilocal('ext', link_infos.index)
|
||||
endif
|
||||
else
|
||||
" append extension iff one not already present or it's not the targeted
|
||||
" append extension if one not already present or it's not the targeted
|
||||
" wiki extension - https://github.com/vimwiki/vimwiki/issues/950
|
||||
let ext = fnamemodify(link_text, ':e')
|
||||
let ext_with_dot = '.' . ext
|
||||
if ext ==? '' || ext_with_dot !=? vimwiki#vars#get_wikilocal('ext', link_infos.index)
|
||||
|
||||
" Check if a .md must be added
|
||||
" See #1271 to modify files with a "."
|
||||
let do_add_ext = ext ==? ''
|
||||
if vimwiki#vars#get_syntaxlocal('open_link_add_ext')
|
||||
let do_add_ext = do_add_ext || ext_with_dot !=? vimwiki#vars#get_wikilocal('ext', link_infos.index)
|
||||
endif
|
||||
|
||||
" Add the dot
|
||||
if do_add_ext
|
||||
let link_infos.filename .= vimwiki#vars#get_wikilocal('ext', link_infos.index)
|
||||
endif
|
||||
endif
|
||||
|
||||
@@ -100,7 +100,8 @@ function! s:normalize_link_syntax_n() abort
|
||||
let sub = vimwiki#base#normalize_link_in_diary(lnk)
|
||||
else
|
||||
let sub = vimwiki#base#normalize_link_helper(lnk,
|
||||
\ vimwiki#vars#get_global('rxWord'), '',
|
||||
\ vimwiki#vars#get_global('rxWord'),
|
||||
\ vimwiki#vars#get_global('rxWord'),
|
||||
\ vimwiki#vars#get_syntaxlocal('Link1'))
|
||||
endif
|
||||
call vimwiki#base#replacestr_at_cursor('\V'.lnk, sub)
|
||||
|
||||
@@ -851,6 +851,10 @@ function! s:get_common_syntaxlocal() abort
|
||||
" HTML comment
|
||||
let res.comment_regex = {'type': type(''), 'default': '\%(^\s*%%.*$\|<!--\%([^>]\|\n\)*-->\)'}
|
||||
|
||||
" Opening link with dot in the ref, see #1271 and ref and Brennen comment:
|
||||
" -- https://github.com/vimwiki/vimwiki/issues/1271#issuecomment-1482207680
|
||||
let res.open_link_add_ext = {'type': type(1), 'default': 1}
|
||||
|
||||
return res
|
||||
endfunction
|
||||
|
||||
|
||||
+20
-4
@@ -479,13 +479,13 @@ glp Decrease the "done" status.
|
||||
gll n Increase the level of a list item.
|
||||
Remap command: `<Plug>VimwikiIncreaseLvlSingleItem`
|
||||
gLl Increase the level of a list item and all child items.
|
||||
Remap command: `<Plug>VimwikiIncreaseLvlWholeItem`
|
||||
or gLL Remap command: `<Plug>VimwikiIncreaseLvlWholeItem`
|
||||
|
||||
*vimwiki_glh* *vimwiki_gLh*
|
||||
glh n Decrease the level of a list item.
|
||||
Remap command: `<Plug>VimwikiDecreaseLvlSingleItem`
|
||||
gLh Decrease the level of a list item and all child items.
|
||||
Remap command: `<Plug>VimwikiDecreaseLvlWholeItem`
|
||||
or gLH Remap command: `<Plug>VimwikiDecreaseLvlWholeItem`
|
||||
|
||||
*vimwiki_glr* *vimwiki_gLr*
|
||||
glr n Renumber list items if the cursor is on a numbered
|
||||
@@ -516,6 +516,13 @@ gl- n Make a list item out of a normal line or change the
|
||||
gL- Change the symbol of the current list to -.
|
||||
Remap command: `:VimwikiChangeSymbolInListTo -<CR>`
|
||||
|
||||
*vimwiki_gl+* *vimwiki_gL+*
|
||||
gl+ n Make a list item out of a normal line or change the
|
||||
symbol of the current item to +.
|
||||
Remap command: `:VimwikiChangeSymbolTo +<CR>`
|
||||
gL+ Change the symbol of the current list to +.
|
||||
Remap command: `:VimwikiChangeSymbolInListTo +<CR>`
|
||||
|
||||
*vimwiki_gl1* *vimwiki_gL1*
|
||||
gl1 n Make a list item out of a normal line or change the
|
||||
symbol of the current item to 1., the numbering is
|
||||
@@ -1514,7 +1521,7 @@ In this case, <mathjax_folder> would be "../mathjax" (without quotes).
|
||||
2. Loading MathJax from a CDN-server (needs internet connection).
|
||||
Add to your HTML template the following lines:
|
||||
|
||||
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js?features=es6"></script>
|
||||
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
|
||||
|
||||
|
||||
@@ -3275,7 +3282,7 @@ cannot otherwise convert the link. A customized handler might look like this: >
|
||||
let str = a:value
|
||||
|
||||
" complete URL
|
||||
let url_0 = matchstr(str, g:vimwiki_rxWikiInclMatchUrl)
|
||||
let url_0 = matchstr(str, g:vimwiki_global_vars.rxWikiInclMatchUrl)
|
||||
" URL parts
|
||||
let link_infos = vimwiki#base#resolve_link(url_0)
|
||||
let arg1 = matchstr(str, VimwikiWikiInclMatchArg(1))
|
||||
@@ -4011,6 +4018,7 @@ Contributors and their Github usernames in roughly chronological order:
|
||||
- Aarón Fas (@aaronfc)
|
||||
- @jiamingc
|
||||
- Alex Claman (@claman)
|
||||
- @qadzek
|
||||
|
||||
|
||||
==============================================================================
|
||||
@@ -4030,6 +4038,14 @@ master is retained as a legacy mirror of the dev branch.
|
||||
This is somewhat experimental, and will probably be refined over time.
|
||||
|
||||
|
||||
2024.01.24~
|
||||
|
||||
New:~
|
||||
* PR #1389: Document gLH, gl+, and gL+ mappings
|
||||
* Tidy some aspects of README.md, remove pointers to defunct Matrix
|
||||
channel and Google Group, add wikis.world Mastodon account.
|
||||
|
||||
|
||||
2024.01.22~
|
||||
|
||||
New:~
|
||||
|
||||
+1
-1
@@ -11,7 +11,7 @@ endif
|
||||
let g:loaded_vimwiki = 1
|
||||
|
||||
" Set to version number for release:
|
||||
let g:vimwiki_version = '2024.01.22'
|
||||
let g:vimwiki_version = '2024.01.24'
|
||||
|
||||
" Get the directory the script is installed in
|
||||
let s:plugin_dir = expand('<sfile>:p:h:h')
|
||||
|
||||
+1
-1
@@ -257,7 +257,7 @@ Expect (Correctly formatted tags file):
|
||||
!_TAG_PROGRAM_AUTHOR Vimwiki
|
||||
!_TAG_PROGRAM_NAME Vimwiki Tags
|
||||
!_TAG_PROGRAM_URL https://github.com/vimwiki/vimwiki
|
||||
!_TAG_PROGRAM_VERSION 2023.05.12
|
||||
!_TAG_PROGRAM_VERSION 2024.01.24
|
||||
second-tag Test-Tag.md 13;" vimwiki:Test-Tag\tTest-Tag#second-tag\tTest-Tag#second-tag
|
||||
test-tag Test-Tag.md 5;" vimwiki:Test-Tag\tTest-Tag#a-header\tA header
|
||||
top-tag Test-Tag.md 1;" vimwiki:Test-Tag\tTest-Tag\tTest-Tag
|
||||
|
||||
Reference in New Issue
Block a user