v2024.01.24: Tweak README.md, update version number and changelog.
This commit is contained in:
@@ -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/)
|
their own syntax highlighting. See the [VimWiki Wiki](https://vimwiki.github.io/vimwikiwiki/)
|
||||||
for an example website built with VimWiki!
|
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).
|
If you are interested in contributing see [this section](#helping-vimwiki).
|
||||||
|
|
||||||
With VimWiki, you can:
|
With VimWiki, you can:
|
||||||
@@ -40,8 +39,8 @@ With VimWiki, you can:
|
|||||||
- Export everything to HTML
|
- Export everything to HTML
|
||||||
|
|
||||||
To do a quick start, press `<Leader>ww` (default is `\ww`) to go to your index
|
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`
|
wiki file. By default, it is located in `~/vimwiki/index.wiki`. See
|
||||||
for registering a different path/wiki.
|
`:h vimwiki_list` for registering a different path/wiki.
|
||||||
|
|
||||||
Feed it with the following example:
|
Feed it with the following example:
|
||||||
|
|
||||||
@@ -77,8 +76,10 @@ The result should look something like:
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
VimWiki has been tested on **Vim >= 7.3**. It will likely work on older
|
VimWiki has been tested on **Vim >= 7.3**. It may work on older versions but
|
||||||
versions but will not be officially supported.
|
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
|
### Prerequisites
|
||||||
|
|
||||||
@@ -143,7 +144,7 @@ vim +PluginInstall +qall
|
|||||||
|
|
||||||
#### Manual Install
|
#### 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/`
|
and extract it in `~/.vim/bundle/`
|
||||||
|
|
||||||
Then launch Vim, run `:Helptags` and then `:help vimwiki` to verify it was
|
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`
|
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
|
## Key bindings
|
||||||
|
|
||||||
### Normal mode
|
### Normal mode
|
||||||
@@ -222,11 +233,13 @@ more bindings.
|
|||||||
## Changing Wiki Syntax
|
## Changing Wiki Syntax
|
||||||
|
|
||||||
VimWiki currently ships with 3 syntaxes: VimWiki (default), Markdown
|
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
|
**NOTE:** Only the default syntax ships with a built-in HTML converter. For
|
||||||
Markdown or MediaWiki see `:h vimwiki-option-custom_wiki2html`. Some examples
|
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
|
If you would prefer to use either Markdown or MediaWiki syntaxes, set the
|
||||||
following option in your `.vimrc`:
|
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
|
```vim
|
||||||
let g:vimwiki_global_ext = 0
|
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).
|
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),
|
if you want to turn off support for other extension(for example, disabling
|
||||||
set the following option in your `.vimrc` before packadd vimwiki:
|
accidently creating new wiki and link for normal markdown files), set the
|
||||||
|
following option in your `.vimrc` before packadd vimwiki:
|
||||||
|
|
||||||
```vim
|
```vim
|
||||||
let g:vimwiki_ext2syntax = {}
|
let g:vimwiki_ext2syntax = {}
|
||||||
```
|
```
|
||||||
|
|
||||||
See [g:vimiki_ext2syntax](https://github.com/vimwiki/vimwiki/blob/619f04f89861c58e5a6415a4f83847752928252d/doc/vimwiki.txt#L2652)
|
See [g:vimiki_ext2syntax](https://github.com/vimwiki/vimwiki/blob/619f04f89861c58e5a6415a4f83847752928252d/doc/vimwiki.txt#L2652)
|
||||||
|
|
||||||
## Getting help
|
## Getting help
|
||||||
|
|
||||||
[GitHub issues](https://github.com/vimwiki/vimwiki/issues) are the primary
|
[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:
|
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 webchat](https://web.libera.chat/?channels=#vimwiki)
|
||||||
- Connect via Matrix/Element: [#vimwiki:libera.chat](https://matrix.to/#/#vimwiki:libera.chat)
|
- [@vimwiki@wikis.world](https://wikis.world/@vimwiki) on the Fediverse
|
||||||
- Post to the [mailing list](https://groups.google.com/forum/#!forum/vimwiki).
|
|
||||||
|
|
||||||
## Helping VimWiki
|
## Helping VimWiki
|
||||||
|
|
||||||
VimWiki has a lot of users but only very few recurring developers or people
|
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!
|
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)
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
|
|||||||
@@ -4018,6 +4018,7 @@ Contributors and their Github usernames in roughly chronological order:
|
|||||||
- Aarón Fas (@aaronfc)
|
- Aarón Fas (@aaronfc)
|
||||||
- @jiamingc
|
- @jiamingc
|
||||||
- Alex Claman (@claman)
|
- Alex Claman (@claman)
|
||||||
|
- @qadzek
|
||||||
|
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
@@ -4037,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.
|
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~
|
2024.01.22~
|
||||||
|
|
||||||
New:~
|
New:~
|
||||||
|
|||||||
+1
-1
@@ -11,7 +11,7 @@ endif
|
|||||||
let g:loaded_vimwiki = 1
|
let g:loaded_vimwiki = 1
|
||||||
|
|
||||||
" Set to version number for release:
|
" 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
|
" Get the directory the script is installed in
|
||||||
let s:plugin_dir = expand('<sfile>:p:h:h')
|
let s:plugin_dir = expand('<sfile>:p:h:h')
|
||||||
|
|||||||
Reference in New Issue
Block a user