Need help with markdown-links?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

tchayen
141 Stars 36 Forks MIT License 92 Commits 26 Opened issues

Description

Command that displays a graph of local links between markdown files

Services available

!
?

Need anything else?

Contributors list

Markdown Links

Adds command

Show Graph
that displays a graph of local links between Markdown files in the current working directory.

Gives better insights into structure of your files if you are writinga wiki, a Zettelkasten style notebook or documentation.

Demo GIF

Workflow

Recommended workflow is either keeping the graph open and using it as an alternative to the explorer sidebar or checking the it from time to time.

The graph refreshes automatically every time you:

  • Update a Markdown title of the file.
  • Change links to other files.
  • Create a new file and add give it a title.
  • Remove a file.

When active file in the editor changes and it matches one of the files in the graph – it will be highlighted.

Concepts

  • Title is always the first Markdown heading of depth 1, i.e.
    # Title
    .
  • Files which do not have a title do not appear in the graph.
  • Files can link to other files using local Markdown links, ID-based links, or
    [file-name]
    links.
  • The graph is not directed. It doesn't show which file has the link and which one is linked.
  • Directory structure is not relevant for the graph. All that matters is the mutual links between files.

Example

# Title

Link can be present in text or on a special list.

Linked

Named reference can also be used, like this: Reference.

Settings

This extension contributes the following settings:

markdown-links.showColumn

Controls in which column should the graph appear. Refer to Column values. Defaults to

beside
.

markdown-links.openColumn

Controls in which column should clicked files open. Refer to Column values. Defaults to

one
.

Column values

  • active
    – in the currently focused column.
  • beside
    – other than the current.
  • one
    (default),
    two
    ,
    three
    ,
    four
    ,
    five
    ,
    six
    ,
    seven
    ,
    eight
    ,
    nine
    – respective editor columns.

markdown-links.fileIdRegexp

A regular expression used to find the file ID for use in wiki-style links.

markdown-links.graphType

  • default
    (default)
  • obsidian
    - obsidian like graph

markdown-links.titleMaxLength

The maximum title length before being abbreviated. Set to 0 or less to disable.

Example

The sentence:

Type checking a multithreaded functional language with session types

When abbreviated for a maximum length of 24, becomes:

Type checking a multithr...

Roadmap

Plans for development are roughly summarized in the Roadmap.

Changelog

Refer to the CHANGELOG.md file.

Contributing

You are very welcome to open an issue or a pull request with changes.

If it is your first time with vscode extension, make sure to checkout Official Guides.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.