Link Builder for `vite-plugin-md`

This repo is hosted externally but provided as a "built-in" part of the vite-plugin-md plugin.

Provides a power-user features for the links in your vite-plugin-md documents.

Usage

// vite.config.js
import Markdown from 'vite-plugin-md'
import { link } from '@yankeeinlondon/link-builder'

export default defineConfig({
  // ...
  plugins: [
    Markdown({ builders: [link()] }),
  ],
})

Default Behavior

With no configuration passed into link() you will get the following behavior:

Class Attribution
- internal vs. external links
- any reference to a http (versus https:) resource will be given the class "insecure"
- if a non-HTTP protocol is specified (e.g., mailto:, file:, etc.)
- if a document has an href directly to an image, document, code the content type will be be given a class
- anchor links (aka, links to the same page) will also get a class
VueJS Router
- any internal link will be converted from <a href="xyz"> link to a <router-link to="xyz" > and the relative paths needed to produce a valid route will be calculated for you
Link Cleanup
- in vs-code (and various other editors), linking between two Markdown files is supported with autocomplete but the completed link maps directly to the markdown FILE (aka, has .md extension)
- this is desireable for file based linking but needs to be tidied up when converting to HTTP based navigation
- The default configuration will:
  - remove index.md fully just leaving the "directory" or "route"
  - remove .md from all other links

Configuration

The configuration is all done with a single dictionary configuration object passed into link( config ) and is fully typed (LinkOptions). Rather than documenting this twice, just refer to the typed documentation in the config object.

Current Tags

1.2.1 ... latest (3 years ago)

24 Versions