From 84c9a59087e74d6bd7761cd4a920d9390c2a65f9 Mon Sep 17 00:00:00 2001 From: Sidney Liebrand Date: Sat, 1 May 2021 16:50:34 +0200 Subject: [PATCH] Update README: Add an example of jumping to next / previous headers --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8a0ad39..c974894 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Thank you for making this plugin better!
  • Table of Contents
  • Install
  • Quick start
    • -
  • Examples
    show 23 items
      +
    • Examples
      show 24 items
      • Folds
      • Insert mode fragment completion
      • Dead link detection
        • @@ -86,6 +86,7 @@ Thank you for making this plugin better!
      • Toggle as bold / italic / inline-code / strikethrough
      • Convert CSV to table (and back)
      • Jump to header
        • +
      • Jump to next / previous header
      • Generate or update TOC
      • Generate or update TOC as <details>
      • Open TOC in quickfix window
        • @@ -637,6 +638,7 @@ and [`g:mkdx#settings.table.header_divider`](#gmkdxsettingstableheader_divider). ## Jump to header + ![mkdx jump to header](doc/gifs/vim-mkdx-jump-to-header.gif) Press [\](#gmkdxsettingsmapprefix)j to jump to a fragment identifier within the document. @@ -652,6 +654,11 @@ This behaviour can be disabled by overriding [`g:mkdx#settings.links.fragment.ju " :h mkdx-mapping-jump-to-header ``` +## Jump to next / previous header + +Use ]] to jump to the next header and [[ to +jump to the previous header. Both mappings support counts and do not wrap around. + ## Generate or update TOC ![mkdx generate or update table of contents](doc/gifs/vim-mkdx-gen-or-upd-toc.gif) @@ -1499,7 +1506,8 @@ This setting is [auto updated](#gmkdxsettingsauto_updateenable) when available. Mappings can be turned off all together with [`g:mkdx#settings.map.enable`](#gmkdxsettingsmapenable). The plugin checks if a mapping exists before creating it. If it exists, it will not create the mapping. -In case a mapping that this plugin provides doesn't work, please check if you have it in your _.vimrc_. +In case a mapping that this plugin provides doesn't work, please check if you have it in your _.vimrc_ and also try `:verbose map [mapping]` +where `[mapping]` is the mapping that doesn't work e.g. `` or `gf`. The below list contains all mappings that mkdx creates by default. To remap functionality: [remapping functionality](#remapping-functionality). To prevent mapping of a key from happening, see: [unmapping functionality](#unmapping-functionality-using-nop). @@ -1543,6 +1551,8 @@ To prevent mapping of a key from happening, see: [unmapping functionality](#unma |Open external file|visual|gx|`(mkdx-gx-visual)`| |Indent numbered list item|tab|`(mkdx-indent)`| |Unindent numbered list item|shift+tab|`(mkdx-unindent)`| +|Jump to next header|]]|`(mkdx-jump-to-next-section)`| +|Jump to prev header|[[|`(mkdx-jump-to-prev-section)`| ## Remapping functionality @@ -1642,6 +1652,7 @@ See [CHANGELOG.md](CHANGELOG.md) for older changes. ## Edge (not yet on vim.org) +- Add: ability to jump to next / previous header with ]] and [[ ([#146](../../issues/146)) - Fix: relocate syntax file for better compatibility ([#127](../../issues/127)) - Fix: CriticMarkup highlighting works properly now ([#128](../../issues/128)) - Fix: Support chinese when generating table of contents link fragments ([#130](../../issues/130))