wikilink

README

Wikilink

This package aims to handle wikilinks in markdown files. I'm not sure whether its name should be singular or plural.

Assumptions

This package assumes your wikilinks don't contain any spaces (you-need-to-write-filenames-like-this).

Documentation

Index

• type Doc
• type DocCollection
  • func Transform(inDir, outDir string) (summary DocCollection, err error)

Types

type Doc

type Doc struct {
	// contains filtered or unexported fields
}

Doc contains a list of forwardlinks (links to other Docs) and backlinks (other Docs linking to here) as lists of filenames without file extensions

type DocCollection

type DocCollection map[string]Doc

DocCollection is a map associating filenames (without file extensions) to Docs

func Transform

func Transform(inDir, outDir string) (summary DocCollection, err error)

Transform receives two directory paths and processes the wikilinks in the former to produce markdown files with regular links in the latter. It returns a summary of the processed Docs (DocCollection) and checks for broken links.