Skip to content

TROUBLESHOOTING-FAQ.md

Latest commit

 

History

History
71 lines (52 loc) · 3.37 KB

TROUBLESHOOTING-FAQ.md

File metadata and controls

71 lines (52 loc) · 3.37 KB

Troubleshooting / FAQ

Autocomplete / Intellisense is not working - why?

IMPORTANT

Quick suggestions are NOT enabled by default in Markdown, so to get suggestions, you have to manually triggerSuggest (⌃Space by default) OR put this in settings.json:

"[markdown]": {
    "editor.quickSuggestions": true
}

What other settings do you recommend when using this extension?

See the RECOMMENDED-SETTINGS doc.

Troubleshooting Checklist

Before filing a new issue, please try to verify if this is a workspace / configuration issue, or an extension / os issue:

  • Checkout the repo: git clone git@github.com:kortina/vscode-markdown-notes.git
  • Open the test notebook directory: cd vscode-markdown-notes/test && code .
  • Open top.md in the test workspace in VS Code
  • typing [[t, triggerSuggest (⌃Space by default) gives completions: test.md, top.md
  • typing [[s, triggerSuggest (⌃Space by default) gives completions: sub.md, sub2.md
  • typing #a, triggerSuggest (⌃Space by default) gives completions: #another_tag, #tag
  • typing [[test.md]], moving cursor over this word, peekDefinition (⌥F12 by default) opens Peek Definition window
  • Did your bug occur in the test directory?
    • Yes
    • No

New note is not working - why?

New Note works only when you are in a workspace. Look here for more information on workspaces in VS Code.

How can I disable syntax highlighting for @words / pandoc-style citations?

If you wish to turn off the syntax highlighting for pandoc-style citations which use the same syntax as @username handles (e.g. GitHub or Twitter), you can do so by overriding the color in your settings:

"editor.tokenColorCustomizations": {
  "textMateRules": [
    {
      "scope": "support.function.text.markdown.notes.bibtex.key",
      "settings": {
        "foreground": "#ffffff"
      }
    },
  ],
}

Known Issues

  • The ctrl+o VSCodeVim jumplist shortcut does not return you to the correct place after using "Go to Definition" (ctrl+]): VSCodeVim/Vim#3277 (The VSCode Go Back command (ctrl+-) does work, however.)
  • This extension sets the wordPattern for 'markdown' in order to (1) enable proper completion of relative paths and (2) make it such that if you cmd+shift+f on a #tag the search will prefill with "#tag" and not just "tag":
    vscode.languages.setLanguageConfiguration('markdown', { wordPattern: /([\#\.\/\\\w_]+)/ });